diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index ba928931f303a..a824aa7ea29e2 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -73,6 +73,7 @@ enabled: - test/functional/apps/discover/config.ts - test/functional/apps/getting_started/config.ts - test/functional/apps/home/config.ts + - test/functional/apps/kibana_overview/config.ts - test/functional/apps/management/config.ts - test/functional/apps/saved_objects_management/config.ts - test/functional/apps/status_page/config.ts diff --git a/.buildkite/pipelines/performance/daily.yml b/.buildkite/pipelines/performance/daily.yml index 4e243a23f1e02..fdc4ae17d69a2 100644 --- a/.buildkite/pipelines/performance/daily.yml +++ b/.buildkite/pipelines/performance/daily.yml @@ -25,6 +25,12 @@ steps: # queue: n2-2 # depends_on: tests + - label: ':chart_with_upwards_trend: Report performance metrics to ci-stats' + command: .buildkite/scripts/steps/functional/report_performance_metrics.sh + agents: + queue: n2-2 + depends_on: tests + - wait: ~ continue_on_failure: true diff --git a/.buildkite/scripts/build_kibana.sh b/.buildkite/scripts/build_kibana.sh index d450e988799bc..eb7adae732d79 100755 --- a/.buildkite/scripts/build_kibana.sh +++ b/.buildkite/scripts/build_kibana.sh @@ -2,6 +2,8 @@ set -euo pipefail +source .buildkite/scripts/common/util.sh + export KBN_NP_PLUGINS_BUILT=true echo "--- Build Kibana Distribution" diff --git a/.buildkite/scripts/steps/checks.sh b/.buildkite/scripts/steps/checks.sh index bffb919eaa8c9..9937a25758e41 100755 --- a/.buildkite/scripts/steps/checks.sh +++ b/.buildkite/scripts/steps/checks.sh @@ -11,7 +11,6 @@ export DISABLE_BOOTSTRAP_VALIDATION=false .buildkite/scripts/steps/checks/telemetry.sh .buildkite/scripts/steps/checks/ts_projects.sh .buildkite/scripts/steps/checks/jest_configs.sh -.buildkite/scripts/steps/checks/doc_api_changes.sh .buildkite/scripts/steps/checks/kbn_pm_dist.sh .buildkite/scripts/steps/checks/plugin_list_docs.sh .buildkite/scripts/steps/checks/bundle_limits.sh diff --git a/.buildkite/scripts/steps/checks/doc_api_changes.sh b/.buildkite/scripts/steps/checks/doc_api_changes.sh deleted file mode 100755 index 73a2bb9409d02..0000000000000 --- a/.buildkite/scripts/steps/checks/doc_api_changes.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env bash - -set -euo pipefail - -source .buildkite/scripts/common/util.sh - -echo --- Check Doc API Changes -checks-reporter-with-killswitch "Check Doc API Changes" \ - node scripts/check_published_api_changes diff --git a/.buildkite/scripts/steps/functional/report_performance_metrics.sh b/.buildkite/scripts/steps/functional/report_performance_metrics.sh new file mode 100644 index 0000000000000..66a5ac27a8dff --- /dev/null +++ b/.buildkite/scripts/steps/functional/report_performance_metrics.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +set -euo pipefail + +source .buildkite/scripts/common/util.sh + +# TODO: Add new user and change lines accordingly +USER_FROM_VAULT="$(retry 5 5 vault read -field=username secret/kibana-issues/dev/ci_stats_performance_metrics)" +PASS_FROM_VAULT="$(retry 5 5 vault read -field=password secret/kibana-issues/dev/ci_stats_performance_metrics)" +APM_SERVER_URL="https://kibana-ops-e2e-perf.es.us-central1.gcp.cloud.es.io:9243/internal/apm" +BUILD_ID=${BUILDKITE_BUILD_ID} + +.buildkite/scripts/bootstrap.sh + +echo "--- Extract APM metrics & report them to ci-stats" + +node scripts/report_performance_metrics \ + --buildId "${BUILD_ID}" \ + --apm-url "${APM_SERVER_URL}" \ + --apm-username "${USER_FROM_VAULT}" \ + --apm-password "${PASS_FROM_VAULT}" diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4c2348df2ffbe..6813dcaa33c09 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -202,6 +202,7 @@ /x-pack/test/functional/apps/transform/ @elastic/ml-ui /x-pack/test/functional/services/transform/ @elastic/ml-ui /x-pack/test/functional_basic/apps/transform/ @elastic/ml-ui +/x-pack/packages/ml/ @elastic/ml-ui /packages/kbn-aiops-utils @elastic/ml-ui /examples/response_stream/ @elastic/ml-ui @@ -257,9 +258,9 @@ #CC# /packages/kbn-expect/ @elastic/kibana-operations /.buildkite/ @elastic/kibana-operations -# Scalability testing -/packages/kbn-performance-testing-dataset-extractor/ @elastic/kibana-scalability-testing -/packages/kbn-scalability-simulation-generator/ @elastic/kibana-scalability-testing +# Performance testing +/packages/kbn-performance-testing-dataset-extractor/ @elastic/kibana-performance-testing +/packages/kbn-scalability-simulation-generator/ @elastic/kibana-performance-testing # Quality Assurance /src/dev/code_coverage @elastic/kibana-qa @@ -291,7 +292,6 @@ /packages/kbn-logging-mocks/ @elastic/kibana-core /packages/kbn-http-tools/ @elastic/kibana-core /src/plugins/saved_objects_management/ @elastic/kibana-core -/src/dev/run_check_published_api_changes.ts @elastic/kibana-core /src/plugins/advanced_settings/ @elastic/kibana-core /x-pack/plugins/global_search_bar/ @elastic/kibana-core /test/analytics @elastic/kibana-core diff --git a/.i18nrc.json b/.i18nrc.json index 0ab8e6b490a12..8c98fc415c910 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -7,7 +7,7 @@ "bfetch": "src/plugins/bfetch", "charts": "src/plugins/charts", "console": "src/plugins/console", - "core": "src/core", + "core": ["src/core", "packages/core/i18n/core-i18n-browser-internal"], "customIntegrations": "src/plugins/custom_integrations", "dashboard": "src/plugins/dashboard", "controls": "src/plugins/controls", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index a3c9c51cd2716..aa8d70b3f87a3 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 2362df77d806d..b4359ef0e6fac 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 33f5b265739b2..b84273128b873 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github summary: API docs for the aiops plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index a9a38362bad81..c660f149a18f7 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 2b106be3920a9..602ed47c913e3 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -790,7 +790,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"GET /internal/apm/backends/operations\" | \"GET /internal/apm/backends/operations/spans\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"GET /internal/apm/backends/operations\" | \"GET /internal/apm/backends/operations/spans\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -4920,38 +4920,6 @@ }, ", { pageLoadDistribution: { pageLoadDistribution: { x: number; y: number; }[]; percentiles: Record | undefined; minDuration: number; maxDuration: number; } | null; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/ux/client-metrics\": ", - "ServerRoute", - "<\"GET /internal/apm/ux/client-metrics\", ", - "TypeC", - "<{ query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ uiFilters: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>, ", - "PartialC", - "<{ urlQuery: ", - "StringC", - "; percentile: ", - "StringC", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { pageViews: { value: number; }; totalPageLoadDuration: { value: number; }; backEnd: { value: number; }; frontEnd: { value: number; }; }, ", - "APMRouteCreateOptions", ">; \"GET /internal/apm/observability_overview/has_data\": ", "ServerRoute", "<\"GET /internal/apm/observability_overview/has_data\", undefined, ", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 22d5292e01528..6100122ca8cb1 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index a4e6037e7b41c..9efb27bdf70d3 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index d91d6b14b30bf..75a4484d9dbca 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 964bbe8ce5872..d15bfd331d410 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 9e2f532071351..8e6b7ff04c30a 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index ac24cd50d2d6b..2d9fe262fab2b 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 34b7f273f271e..015725fc4b46b 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index c6ac3bd0c1ee7..552c5f84bbb6a 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 5d5de2b8f163c..ecd66045beb20 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index f85640721d867..67400c3730c05 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 6f06c69c9a35c..c1181b59c80c0 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -1583,13 +1583,7 @@ "{@link I18nStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.I18nStart", - "text": "I18nStart" - } + "I18nStart" ], "path": "src/core/public/index.ts", "deprecated": false @@ -2647,9 +2641,9 @@ "tags": [], "label": "I18nStart", "description": [ - "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + "\r\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\r\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\r\n" ], - "path": "src/core/public/i18n/i18n_service.tsx", + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false, "children": [ { @@ -2659,12 +2653,12 @@ "tags": [], "label": "Context", "description": [ - "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + "\r\nReact Context provider required as the topmost component for any i18n-compatible React tree." ], "signature": [ "({ children }: { children: React.ReactNode; }) => JSX.Element" ], - "path": "src/core/public/i18n/i18n_service.tsx", + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false, "children": [ { @@ -2674,7 +2668,7 @@ "tags": [], "label": "{ children }", "description": [], - "path": "src/core/public/i18n/i18n_service.tsx", + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false, "children": [ { @@ -2687,7 +2681,7 @@ "signature": [ "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" ], - "path": "src/core/public/i18n/i18n_service.tsx", + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false } ] @@ -13969,9 +13963,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", @@ -16380,9 +16374,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", @@ -17583,9 +17577,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", @@ -21106,9 +21100,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", @@ -24176,7 +24170,7 @@ "tags": [], "label": "AnalyticsServicePreboot", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}" + "\r\nExposes the public APIs of the AnalyticsClient during the preboot phase\r\n{@link AnalyticsClient}" ], "signature": [ "{ optIn: (optInConfig: ", @@ -24197,7 +24191,7 @@ "ContextProviderOpts", ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/analytics/analytics_service.ts", + "path": "node_modules/@types/kbn__core-analytics-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -24208,7 +24202,7 @@ "tags": [], "label": "AnalyticsServiceSetup", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" + "\r\nExposes the public APIs of the AnalyticsClient during the setup phase.\r\n{@link AnalyticsClient}" ], "signature": [ "{ optIn: (optInConfig: ", @@ -24229,7 +24223,7 @@ "ContextProviderOpts", ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/analytics/analytics_service.ts", + "path": "node_modules/@types/kbn__core-analytics-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -24240,7 +24234,7 @@ "tags": [], "label": "AnalyticsServiceStart", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" + "\r\nExposes the public APIs of the AnalyticsClient during the start phase\r\n{@link AnalyticsClient}" ], "signature": [ "{ optIn: (optInConfig: ", @@ -24251,7 +24245,7 @@ "TelemetryCounter", ">; }" ], - "path": "src/core/server/analytics/analytics_service.ts", + "path": "node_modules/@types/kbn__core-analytics-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -24869,9 +24863,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 42dd8263b124e..e3b2da5c430d1 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2527 | 15 | 940 | 29 | +| 2527 | 15 | 938 | 29 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index f71fa5999f448..ccd83243240cc 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2527 | 15 | 940 | 29 | +| 2527 | 15 | 938 | 29 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index ff3e958e0529f..a9682a8e3b4a1 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2527 | 15 | 940 | 29 | +| 2527 | 15 | 938 | 29 | ## Client diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 23bd766d9ae5d..dbe127e3f003d 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2527 | 15 | 940 | 29 | +| 2527 | 15 | 938 | 29 | ## Client diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index bac90d13acfc3..a4443c941dd86 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2527 | 15 | 940 | 29 | +| 2527 | 15 | 938 | 29 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 1992adc2ffa81..f7586442664bc 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index a05ab42c32be8..8dc6d7fdcfb6f 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 80ea33452576a..e8953c4281e28 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index a9cbb8be306c9..0c8ca92075473 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -4576,42 +4576,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.isFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isFilters", - "description": [], - "signature": [ - "(x: unknown) => x is ", - "Filter", - "[]" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.isFilters.$1", - "type": "Unknown", - "tags": [], - "label": "x", - "description": [], - "signature": [ - "unknown" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.isPartialResponse", @@ -4701,13 +4665,7 @@ "description": [], "signature": [ "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, @@ -8333,19 +8291,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.FilterStateStore", - "type": "Enum", - "tags": [], - "label": "FilterStateStore", - "description": [ - "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.KBN_FIELD_TYPES", @@ -8503,13 +8448,7 @@ ], "signature": [ "{ calculateAutoTimeExpression: (range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", @@ -8667,27 +8606,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.EsQueryConfig", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "EsQueryConfig", - "description": [], - "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.EsQuerySortValue", @@ -8741,40 +8659,13 @@ " | ", "Query", "[] | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.ExistsFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "ExistsFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "FilterMeta", - "; query: { exists?: { field: string; } | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.ExpressionFunctionKibana", @@ -8918,129 +8809,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.Filter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "Filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.IAggConfig", @@ -9573,42 +9341,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.MatchAllFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "MatchAllFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: MatchAllFilterMeta; query: { match_all: ", - "QueryDslMatchAllQuery", - "; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.NowProviderInternalContract", @@ -9653,43 +9385,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.PhraseFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "PhraseFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.QueryState", @@ -9701,13 +9396,7 @@ ], "signature": [ "{ time?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; refreshInterval?: ", { "pluginId": "data", @@ -9726,44 +9415,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.RangeFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.RangeFilterParams", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilterParams", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.RefreshInterval", @@ -9838,15387 +9489,1738 @@ }, { "parentPluginId": "data", - "id": "def-public.TimeRange", + "id": "def-public.TypeMeta", "type": "Type", - "tags": [ - "deprecated", - "deprecated" - ], - "label": "TimeRange", + "tags": [], + "label": "TypeMeta", "description": [ - "\n" + "\nInterface for metadata about rollup indices" ], "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/locator.ts" - }, + "{ aggs?: Record | undefined; params?: { rollup_index: string; } | undefined; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "data", + "id": "def-public.AggGroupLabels", + "type": "Object", + "tags": [], + "label": "AggGroupLabels", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false, + "children": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" + "parentPluginId": "data", + "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", + "type": "string", + "tags": [], + "label": "[AggGroupNames.Buckets]", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" + "parentPluginId": "data", + "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", + "type": "string", + "tags": [], + "label": "[AggGroupNames.Metrics]", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false }, { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, + "parentPluginId": "data", + "id": "def-public.AggGroupLabels.AggGroupNames.None", + "type": "string", + "tags": [], + "label": "[AggGroupNames.None]", + "description": [], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.AggGroupNames", + "type": "Object", + "tags": [], + "label": "AggGroupNames", + "description": [], + "signature": [ + "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" + ], + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.exporters", + "type": "Object", + "tags": [], + "label": "exporters", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV", + "type": "Function", + "tags": [], + "label": "datatableToCSV", + "description": [], + "signature": [ + "({ columns, rows }: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.exporters.datatableToCSV.$2", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + } + ] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" + "parentPluginId": "data", + "id": "def-public.exporters.CSV_MIME_TYPE", + "type": "string", + "tags": [], + "label": "CSV_MIME_TYPE", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "parentPluginId": "data", + "id": "def-public.exporters.cellHasFormulas", + "type": "Function", + "tags": [], + "label": "cellHasFormulas", + "description": [], + "signature": [ + "(val: string) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.cellHasFormulas.$1", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + } + ] }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas", + "type": "Function", + "tags": [], + "label": "tableHasFormulas", + "description": [], + "signature": [ + "(columns: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[], rows: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + "[]) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas.$1", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.exporters.tableHasFormulas.$2", + "type": "Array", + "tags": [], + "label": "rows", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPatterns", + "type": "Object", + "tags": [], + "label": "indexPatterns", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", + "type": "string", + "tags": [], + "label": "ILLEGAL_CHARACTERS_KEY", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", + "type": "string", + "tags": [], + "label": "CONTAINS_SPACES_KEY", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS_VISIBLE", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", + "type": "Array", + "tags": [], + "label": "ILLEGAL_CHARACTERS", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isFilterable", + "type": "Function", + "tags": [], + "label": "isFilterable", + "description": [], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isFilterable.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isNestedField", + "type": "Function", + "tags": [], + "label": "isNestedField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isNestedField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.isMultiField", + "type": "Function", + "tags": [], + "label": "isMultiField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.isMultiField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeMulti.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeNested", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeNested", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.getFieldSubtypeNested.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" - }, - { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" - }, - { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" - }, - { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" - }, - { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.TypeMeta", - "type": "Type", - "tags": [], - "label": "TypeMeta", - "description": [ - "\nInterface for metadata about rollup indices" - ], - "signature": [ - "{ aggs?: Record | undefined; params?: { rollup_index: string; } | undefined; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels", - "type": "Object", - "tags": [], - "label": "AggGroupLabels", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.Buckets", - "type": "string", - "tags": [], - "label": "[AggGroupNames.Buckets]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.Metrics", - "type": "string", - "tags": [], - "label": "[AggGroupNames.Metrics]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggGroupLabels.AggGroupNames.None", - "type": "string", - "tags": [], - "label": "[AggGroupNames.None]", - "description": [], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.AggGroupNames", - "type": "Object", - "tags": [], - "label": "AggGroupNames", - "description": [], - "signature": [ - "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" - ], - "path": "src/plugins/data/common/search/aggs/agg_groups.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esFilters", - "description": [ - "\nFilter helpers namespace:" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.FILTERS", - "type": "Object", - "tags": [], - "label": "FILTERS", - "description": [], - "signature": [ - "typeof ", - "FILTERS" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.FilterStateStore", - "type": "Object", - "tags": [], - "label": "FilterStateStore", - "description": [], - "signature": [ - "typeof ", - "FilterStateStore" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter", - "type": "Function", - "tags": [], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter.$1", - "type": "boolean", - "tags": [], - "label": "isPinned", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildEmptyFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter", - "type": "Function", - "tags": [], - "label": "buildPhrasesFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: PhraseFilterValue[], indexPattern: ", - "DataViewBase", - ") => ", - "PhrasesFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$2", - "type": "Array", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "PhraseFilterValue[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhrasesFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter", - "type": "Function", - "tags": [], - "label": "buildExistsFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", indexPattern: ", - "DataViewBase", - ") => ", - "ExistsFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildExistsFilter.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter", - "type": "Function", - "tags": [], - "label": "buildPhraseFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", value: PhraseFilterValue, indexPattern: ", - "DataViewBase", - ") => ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$2", - "type": "CompoundType", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "string | number | boolean" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildPhraseFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter", - "type": "Function", - "tags": [], - "label": "buildQueryFilter", - "description": [], - "signature": [ - "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", - "FilterMeta", - " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$3", - "type": "string", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildQueryFilter.$4", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "FilterMeta", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter", - "type": "Function", - "tags": [], - "label": "buildRangeFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: ", - "RangeFilterParams", - ", indexPattern?: ", - "DataViewBase", - " | undefined, formattedValue?: string | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$2", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "RangeFilterParams" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.buildRangeFilter.$4", - "type": "string", - "tags": [], - "label": "formattedValue", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhraseFilter", - "type": "Function", - "tags": [], - "label": "isPhraseFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhraseFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isExistsFilter", - "type": "Function", - "tags": [], - "label": "isExistsFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "ExistsFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhrasesFilter", - "type": "Function", - "tags": [], - "label": "isPhrasesFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhrasesFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isRangeFilter", - "type": "Function", - "tags": [], - "label": "isRangeFilter", - "description": [], - "signature": [ - "(filter?: ", - "Filter", - " | undefined) => filter is ", - "RangeFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isMatchAllFilter", - "type": "Function", - "tags": [], - "label": "isMatchAllFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "MatchAllFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isMatchAllFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isQueryStringFilter", - "type": "Function", - "tags": [], - "label": "isQueryStringFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "QueryStringFilter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isQueryStringFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.isFilterPinned", - "type": "Function", - "tags": [], - "label": "isFilterPinned", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => boolean | undefined" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.isFilterPinned.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.toggleFilterNegated", - "type": "Function", - "tags": [], - "label": "toggleFilterNegated", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", - "FilterStateStore", - "; } | undefined; query?: Record | undefined; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.toggleFilterNegated.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.disableFilter", - "type": "Function", - "tags": [], - "label": "disableFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => ", - "Filter" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.disableFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterField", - "type": "Function", - "tags": [], - "label": "getPhraseFilterField", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - ") => string" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterField.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterValue", - "type": "Function", - "tags": [], - "label": "getPhraseFilterValue", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter", - ") => PhraseFilterValue" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getPhraseFilterValue.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter", - "type": "Function", - "tags": [], - "label": "getDisplayValueFromFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ", indexPatterns: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]) => string" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.getDisplayValueFromFilter.$2", - "type": "Array", - "tags": [], - "label": "indexPatterns", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters", - "type": "Function", - "tags": [], - "label": "compareFilters", - "description": [], - "signature": [ - "(first: ", - "Filter", - " | ", - "Filter", - "[], second: ", - "Filter", - " | ", - "Filter", - "[], comparatorOptions?: ", - "FilterCompareOptions", - " | undefined) => boolean" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$1", - "type": "CompoundType", - "tags": [], - "label": "first", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$2", - "type": "CompoundType", - "tags": [], - "label": "second", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.compareFilters.$3", - "type": "Object", - "tags": [], - "label": "comparatorOptions", - "description": [], - "signature": [ - "FilterCompareOptions", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.COMPARE_ALL_OPTIONS", - "type": "Object", - "tags": [], - "label": "COMPARE_ALL_OPTIONS", - "description": [], - "signature": [ - "FilterCompareOptions" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters", - "type": "Function", - "tags": [], - "label": "generateFilters", - "description": [], - "signature": [ - "(filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - ", field: string | ", - "DataViewFieldBase", - ", values: any, operation: string, index: ", - "DataViewBase", - ") => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$1", - "type": "Object", - "tags": [], - "label": "filterManager", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - } - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$2", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "string | ", - "DataViewFieldBase" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$3", - "type": "Any", - "tags": [], - "label": "values", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$4", - "type": "string", - "tags": [], - "label": "operation", - "description": [], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.generateFilters.$5", - "type": "Object", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged", - "type": "Function", - "tags": [], - "label": "onlyDisabledFiltersChanged", - "description": [], - "signature": [ - "(newFilters?: ", - "Filter", - "[] | undefined, oldFilters?: ", - "Filter", - "[] | undefined) => boolean" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged.$1", - "type": "Array", - "tags": [], - "label": "newFilters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.onlyDisabledFiltersChanged.$2", - "type": "Array", - "tags": [], - "label": "oldFilters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esFilters.mapAndFlattenFilters", - "type": "Function", - "tags": [], - "label": "mapAndFlattenFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[]) => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esFilters.mapAndFlattenFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esKuery", - "description": [], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" - }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" - }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression", - "type": "Function", - "tags": [], - "label": "fromKueryExpression", - "description": [], - "signature": [ - "(expression: string | ", - "QueryDslQueryContainer", - ", parseOptions?: Partial<", - "KueryParseOptions", - "> | undefined) => ", - "KueryNode" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression.$1", - "type": "CompoundType", - "tags": [], - "label": "expression", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.fromKueryExpression.$2", - "type": "Object", - "tags": [], - "label": "parseOptions", - "description": [], - "signature": [ - "Partial<", - "KueryParseOptions", - "> | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery", - "type": "Function", - "tags": [], - "label": "toElasticsearchQuery", - "description": [], - "signature": [ - "(node: ", - "KueryNode", - ", indexPattern?: ", - "DataViewBase", - " | undefined, config?: ", - "KueryQueryOptions", - " | undefined, context?: Record | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$1", - "type": "Object", - "tags": [], - "label": "node", - "description": [], - "signature": [ - "KueryNode" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$3", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KueryQueryOptions", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esKuery.toElasticsearchQuery.$4", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "esQuery", - "description": [], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery", - "type": "Function", - "tags": [], - "label": "buildEsQuery", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - " | undefined, queries: ", - "Query", - " | ", - "Query", - "[], filters: ", - "Filter", - " | ", - "Filter", - "[], config?: ", - "EsQueryConfig", - " | undefined) => { bool: ", - "BoolQuery", - "; }" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queries", - "description": [], - "signature": [ - "Query", - " | ", - "Query", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$3", - "type": "CompoundType", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildEsQuery.$4", - "type": "CompoundType", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "EsQueryConfig", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KibanaConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters", - "type": "Function", - "tags": [], - "label": "buildQueryFromFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[] | undefined, indexPattern: ", - "DataViewBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", - "BoolQuery" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.buildQueryFromFilters.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.luceneStringToDsl", - "type": "Function", - "tags": [], - "label": "luceneStringToDsl", - "description": [], - "signature": [ - "(query: string | ", - "QueryDslQueryContainer", - ") => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.luceneStringToDsl.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery", - "type": "Function", - "tags": [], - "label": "decorateQuery", - "description": [], - "signature": [ - "(query: ", - "QueryDslQueryContainer", - ", queryStringOptions: string | ", - "SerializableRecord", - ", dateFormatTZ?: string | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$1", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queryStringOptions", - "description": [], - "signature": [ - "string | ", - "SerializableRecord" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.esQuery.decorateQuery.$3", - "type": "string", - "tags": [], - "label": "dateFormatTZ", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters", - "type": "Object", - "tags": [], - "label": "exporters", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV", - "type": "Function", - "tags": [], - "label": "datatableToCSV", - "description": [], - "signature": [ - "({ columns, rows }: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV.$1", - "type": "Object", - "tags": [], - "label": "__0", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.datatableToCSV.$2", - "type": "Object", - "tags": [], - "label": "__1", - "description": [], - "signature": [ - "CSVOptions" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.CSV_MIME_TYPE", - "type": "string", - "tags": [], - "label": "CSV_MIME_TYPE", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.cellHasFormulas", - "type": "Function", - "tags": [], - "label": "cellHasFormulas", - "description": [], - "signature": [ - "(val: string) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.cellHasFormulas.$1", - "type": "string", - "tags": [], - "label": "val", - "description": [], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas", - "type": "Function", - "tags": [], - "label": "tableHasFormulas", - "description": [], - "signature": [ - "(columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[], rows: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas.$1", - "type": "Array", - "tags": [], - "label": "columns", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[]" - ], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.exporters.tableHasFormulas.$2", - "type": "Array", - "tags": [], - "label": "rows", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]" - ], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns", - "type": "Object", - "tags": [], - "label": "indexPatterns", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY", - "type": "string", - "tags": [], - "label": "ILLEGAL_CHARACTERS_KEY", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.CONTAINS_SPACES_KEY", - "type": "string", - "tags": [], - "label": "CONTAINS_SPACES_KEY", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS_VISIBLE", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.ILLEGAL_CHARACTERS", - "type": "Array", - "tags": [], - "label": "ILLEGAL_CHARACTERS", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isFilterable.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isNestedField", - "type": "Function", - "tags": [], - "label": "isNestedField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isNestedField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isMultiField", - "type": "Function", - "tags": [], - "label": "isMultiField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.isMultiField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeMulti.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.getFieldSubtypeNested.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.validate", - "type": "Function", - "tags": [], - "label": "validate", - "description": [], - "signature": [ - "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.indexPatterns.validate.$1", - "type": "string", - "tags": [], - "label": "indexPattern", - "description": [], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.CidrMask", - "type": "Object", - "tags": [], - "label": "CidrMask", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CidrMask", - "text": "CidrMask" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.dateHistogramInterval", - "type": "Function", - "tags": [], - "label": "dateHistogramInterval", - "description": [], - "signature": [ - "(interval: string) => Interval" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.dateHistogramInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.intervalOptions", - "type": "Array", - "tags": [], - "label": "intervalOptions", - "description": [], - "signature": [ - "({ display: string; val: string; enabled(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" - }, - "): boolean; } | { display: string; val: string; })[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", - "type": "Object", - "tags": [], - "label": "InvalidEsCalendarIntervalError", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsCalendarIntervalError", - "text": "InvalidEsCalendarIntervalError" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.InvalidEsIntervalFormatError", - "type": "Object", - "tags": [], - "label": "InvalidEsIntervalFormatError", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsIntervalFormatError", - "text": "InvalidEsIntervalFormatError" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.IpAddress", - "type": "Object", - "tags": [], - "label": "IpAddress", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IpAddress", - "text": "IpAddress" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", - "type": "Function", - "tags": [], - "label": "isDateHistogramBucketAggConfig", - "description": [], - "signature": [ - "(agg: any) => agg is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketDateHistogramAggConfig", - "text": "IBucketDateHistogramAggConfig" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isDateHistogramBucketAggConfig.$1", - "type": "Any", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isNumberType", - "type": "Function", - "tags": [], - "label": "isNumberType", - "description": [], - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isNumberType.$1", - "type": "Object", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isStringType", - "type": "Function", - "tags": [], - "label": "isStringType", - "description": [], - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isStringType.$1", - "type": "Object", - "tags": [], - "label": "agg", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isType", - "type": "Function", - "tags": [], - "label": "isType", - "description": [], - "signature": [ - "(...types: string[]) => (agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isType.$1", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidEsInterval", - "type": "Function", - "tags": [], - "label": "isValidEsInterval", - "description": [], - "signature": [ - "(interval: string) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidEsInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval", - "type": "Function", - "tags": [], - "label": "isValidInterval", - "description": [], - "signature": [ - "(value: string, baseInterval?: string | undefined) => boolean" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval.$1", - "type": "string", - "tags": [], - "label": "value", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.isValidInterval.$2", - "type": "string", - "tags": [], - "label": "baseInterval", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parentPipelineType", - "type": "string", - "tags": [], - "label": "parentPipelineType", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseEsInterval", - "type": "Function", - "tags": [], - "label": "parseEsInterval", - "description": [], - "signature": [ - "(interval: string) => { value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseEsInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.propFilter", - "type": "Function", - "tags": [], - "label": "propFilter", - "description": [], - "signature": [ - "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.propFilter.$1", - "type": "Uncategorized", - "tags": [], - "label": "prop", - "description": [], - "signature": [ - "P" - ], - "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.siblingPipelineType", - "type": "string", - "tags": [], - "label": "siblingPipelineType", - "description": [], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.termsAggFilter", - "type": "Array", - "tags": [], - "label": "termsAggFilter", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.toAbsoluteDates", - "type": "Function", - "tags": [], - "label": "toAbsoluteDates", - "description": [], - "signature": [ - "(range: ", - "TimeRange", - ") => { from: Date; to: Date; } | undefined" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.aggs.toAbsoluteDates.$1", - "type": "Object", - "tags": [], - "label": "range", - "description": [], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.aggs.boundsDescendingRaw", - "type": "Array", - "tags": [], - "label": "boundsDescendingRaw", - "description": [], - "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats", - "type": "Function", - "tags": [], - "label": "getResponseInspectorStats", - "description": [], - "signature": [ - "(resp?: ", - "SearchResponse", - "> | undefined, searchSource?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - }, - " | undefined) => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestStatistics", - "text": "RequestStatistics" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats.$1", - "type": "Object", - "tags": [], - "label": "resp", - "description": [], - "signature": [ - "SearchResponse", - "> | undefined" - ], - "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.getResponseInspectorStats.$2", - "type": "Object", - "tags": [], - "label": "searchSource", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchSource", - "text": "ISearchSource" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse", - "type": "Function", - "tags": [], - "label": "tabifyAggResponse", - "description": [], - "signature": [ - "(aggConfigs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - ", esResponse: Record, respOpts?: Partial<", - "TabbedResponseWriterOptions", - "> | undefined) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$1", - "type": "Object", - "tags": [], - "label": "aggConfigs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - } - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$2", - "type": "Object", - "tags": [], - "label": "esResponse", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyAggResponse.$3", - "type": "Object", - "tags": [], - "label": "respOpts", - "description": [], - "signature": [ - "Partial<", - "TabbedResponseWriterOptions", - "> | undefined" - ], - "path": "src/plugins/data/common/search/tabify/tabify.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns", - "type": "Function", - "tags": [], - "label": "tabifyGetColumns", - "description": [], - "signature": [ - "(aggs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[], minimalColumns: boolean) => ", - "TabbedAggColumn", - "[]" - ], - "path": "src/plugins/data/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns.$1", - "type": "Array", - "tags": [], - "label": "aggs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[]" - ], - "path": "src/plugins/data/common/search/tabify/get_columns.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.search.tabifyGetColumns.$2", - "type": "boolean", - "tags": [], - "label": "minimalColumns", - "description": [], - "path": "src/plugins/data/common/search/tabify/get_columns.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.UI_SETTINGS", - "type": "Object", - "tags": [], - "label": "UI_SETTINGS", - "description": [], - "signature": [ - "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "setup": { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataPublicPluginSetup", - "description": [ - "\nData plugin public Setup contract" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.ISearchSetup", - "text": "ISearchSetup" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QuerySetup", - "text": "QuerySetup" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - } - ], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart", - "type": "Interface", - "tags": [], - "label": "DataPublicPluginStart", - "description": [ - "\nData plugin public Start contract" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.actions", - "type": "Object", - "tags": [], - "label": "actions", - "description": [ - "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginStartActions", - "text": "DataPublicPluginStartActions" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.dataViews", - "type": "Object", - "tags": [], - "label": "dataViews", - "description": [ - "\ndata views service\n{@link DataViewsContract}" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsServicePublic", - "text": "DataViewsServicePublic" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.datatableUtilities", - "type": "Object", - "tags": [], - "label": "datatableUtilities", - "description": [ - "\nDatatable type utility functions." - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.DatatableUtilitiesService", - "text": "DatatableUtilitiesService" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.indexPatterns", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "indexPatterns", - "description": [ - "\nindex patterns service\n{@link DataViewsContract}" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.DataViewsServicePublic", - "text": "DataViewsServicePublic" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/plugin.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/kibana_services.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/plugin.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" - }, - { - "plugin": "inputControlVis", - "path": "src/plugins/input_control_vis/public/components/editor/controls_tab.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [ - "\nsearch service\n{@link ISearchStart}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.ISearchStart", - "text": "ISearchStart" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.fieldFormats", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - "Omit<", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatsRegistry", - "text": "FieldFormatsRegistry" - }, - ", \"init\" | \"register\"> & { deserialize: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FormatFactory", - "text": "FormatFactory" - }, - "; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/actions/export_csv_action.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts" - }, - { - "plugin": "visTypeTable", - "path": "src/plugins/vis_types/table/public/plugin.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/plugin.ts" - }, - { - "plugin": "visTypeXy", - "path": "src/plugins/vis_types/xy/public/plugin.ts" - }, - { - "plugin": "visTypeVislib", - "path": "src/plugins/vis_types/vislib/public/plugin.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - }, - { - "plugin": "expressionPartitionVis", - "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [ - "\nquery service\n{@link QueryStart}" - ], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStart", - "text": "QueryStart" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.nowProvider", - "type": "Object", - "tags": [], - "label": "nowProvider", - "description": [], - "signature": [ - "{ get: () => Date; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - } - ], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin", - "type": "Class", - "tags": [], - "label": "DataServerPlugin", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataServerPlugin", - "text": "DataServerPlugin" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" - }, - "<", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetup", - "text": "DataPluginSetup" - }, - ", ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ", ", - "DataPluginSetupDependencies", - ", ", - "DataPluginStartDependencies", - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "initializerContext", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup", - "type": "Function", - "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataPluginStartDependencies", - ", ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ", - "DataPluginSetupDependencies", - ") => { search: ", - "ISearchSetup", - "; query: ", - "QuerySetup", - "; fieldFormats: ", - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsSetup", - "text": "FieldFormatsSetup" - }, - "; }" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataPluginStartDependencies", - ", ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginStart", - "text": "DataPluginStart" - }, - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.setup.$2", - "type": "Object", - "tags": [], - "label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }", - "description": [], - "signature": [ - "DataPluginSetupDependencies" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start", - "type": "Function", - "tags": [], - "label": "start", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", { fieldFormats, dataViews, taskManager }: ", - "DataPluginStartDependencies", - ") => { datatableUtilities: ", - "DatatableUtilitiesService", - "; search: ", - "ISearchStart", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - ", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchResponse", - "text": "IEsSearchResponse" - }, - ">; fieldFormats: ", - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - }, - "; indexPatterns: ", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - }, - "; }" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.start.$2", - "type": "Object", - "tags": [], - "label": "{ fieldFormats, dataViews, taskManager }", - "description": [], - "signature": [ - "DataPluginStartDependencies" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataServerPlugin.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => void" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView", - "type": "Class", - "tags": [], - "label": "DataView", - "description": [ - "\nData view class. Central kibana abstraction around multiple indices." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " implements ", - "DataViewBase" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nSaved object id" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.title", - "type": "string", - "tags": [], - "label": "title", - "description": [ - "\nTitle of data view" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", - "description": [ - "\nMap of field formats by field name" - ], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.typeMeta", - "type": "Object", - "tags": [], - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.fields", - "type": "CompoundType", - "tags": [], - "label": "fields", - "description": [ - "\nField list, in extended array format" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [ - "\nTimestamp field name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nType is used to identify rollup index patterns." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.flattenHit", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "flattenHit", - "description": [], - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - } - ], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.flattenHit.$1", - "type": "Object", - "tags": [], - "label": "hit", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.flattenHit.$2", - "type": "CompoundType", - "tags": [], - "label": "deep", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [ - "\nList of meta fields by name" - ], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nSavedObject version" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [ - "\nArray of filters - hides fields in discover" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nArray of namespace ids" - ], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.allowNoIndex", - "type": "boolean", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nPrevents errors when index pattern exists before indices" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the data view. Human readable name used to differentiate data view." - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nconstructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [ - "- config data and dependencies" - ], - "signature": [ - "DataViewDeps" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getName", - "type": "Function", - "tags": [], - "label": "getName", - "description": [ - "\nGet name of Data View" - ], - "signature": [ - "() => string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getOriginalSavedObjectBody", - "description": [ - "\nGet last saved saved object fields" - ], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.resetOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "resetOriginalSavedObjectBody", - "description": [ - "\nReset last saved saved object fields. Used after saving." - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldAttrs", - "type": "Function", - "tags": [], - "label": "getFieldAttrs", - "description": [ - "\nReturns field attributes map" - ], - "signature": [ - "() => { [x: string]: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getComputedFields", - "type": "Function", - "tags": [], - "label": "getComputedFields", - "description": [ - "\nReturns scripted fields" - ], - "signature": [ - "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", - "MappingRuntimeFields", - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nCreates static representation of the data view." - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getSourceFiltering", - "type": "Function", - "tags": [], - "label": "getSourceFiltering", - "description": [ - "\nGet the source filtering configuration for that index." - ], - "signature": [ - "() => { excludes: string[]; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.removeScriptedField", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "removeScriptedField", - "description": [ - "\nRemoves scripted field from field list." - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.removeScriptedField.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of scripted field to remove" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getNonScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getNonScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_views.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.isTimeBased", - "type": "Function", - "tags": [], - "label": "isTimeBased", - "description": [ - "\nDoes the data view have a timestamp field?" - ], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.isTimeNanosBased", - "type": "Function", - "tags": [], - "label": "isTimeNanosBased", - "description": [ - "\nDoes the data view have a timestamp field and is it a date nanos field?" - ], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getTimeField", - "type": "Function", - "tags": [], - "label": "getTimeField", - "description": [ - "\nGet timestamp field as DataViewField or return undefined" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldByName", - "type": "Function", - "tags": [], - "label": "getFieldByName", - "description": [ - "\nGet field by name." - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getAggregationRestrictions", - "type": "Function", - "tags": [], - "label": "getAggregationRestrictions", - "description": [ - "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." - ], - "signature": [ - "() => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getAsSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getAsSavedObjectBody", - "description": [ - "\nReturns index pattern as saved object body for saving" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [ - "\nProvide a field, get its formatter" - ], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForField.$1", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [ - "field to get formatter for" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField", - "type": "Function", - "tags": [], - "label": "addRuntimeField", - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." - ], - "signature": [ - "(name: string, runtimeField: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "Field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.addRuntimeField.$2", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [ - "Runtime field definition" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.hasRuntimeField", - "type": "Function", - "tags": [], - "label": "hasRuntimeField", - "description": [ - "\nChecks if runtime field exists" - ], - "signature": [ - "(name: string) => boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.hasRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeField", - "type": "Function", - "tags": [], - "label": "getRuntimeField", - "description": [ - "\nReturns runtime field if exists" - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | null" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "Runtime field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "getAllRuntimeFields", - "description": [ - "\nGet all runtime field definitions." - ], - "signature": [ - "() => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [ - "map of runtime field definitions by field name" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldsByRuntimeFieldName", - "type": "Function", - "tags": [], - "label": "getFieldsByRuntimeFieldName", - "description": [ - "\nReturns data view fields backed by runtime fields." - ], - "signature": [ - "(name: string) => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.getFieldsByRuntimeFieldName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "runtime field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "map of DataViewFields (that are runtime fields) by field name" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.replaceAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "replaceAllRuntimeFields", - "description": [ - "\nReplaces all existing runtime fields with new fields." - ], - "signature": [ - "(newFields: Record) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.replaceAllRuntimeFields.$1", - "type": "Object", - "tags": [], - "label": "newFields", - "description": [ - "Map of runtime field definitions by field name" - ], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.removeRuntimeField", - "type": "Function", - "tags": [], - "label": "removeRuntimeField", - "description": [ - "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." - ], - "signature": [ - "(name: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.removeRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "- Field name to remove" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getRuntimeMappings", - "type": "Function", - "tags": [], - "label": "getRuntimeMappings", - "description": [ - "\nReturn the \"runtime_mappings\" section of the ES search query." - ], - "signature": [ - "() => ", - "MappingRuntimeFields" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForFieldNoDefault", - "type": "Function", - "tags": [], - "label": "getFormatterForFieldNoDefault", - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists." - ], - "signature": [ - "(fieldname: string) => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.getFormatterForFieldNoDefault.$1", - "type": "string", - "tags": [], - "label": "fieldname", - "description": [ - "name of field to get formatter for" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs", - "type": "Function", - "tags": [], - "label": "setFieldAttrs", - "description": [ - "\nSet field attribute" - ], - "signature": [ - "(fieldName: string, attrName: K, value: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set attribute on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$2", - "type": "Uncategorized", - "tags": [], - "label": "attrName", - "description": [ - "name of attribute to set" - ], - "signature": [ - "K" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldAttrs.$3", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [ - "value of attribute" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel", - "type": "Function", - "tags": [], - "label": "setFieldCustomLabel", - "description": [ - "\nSet field custom label" - ], - "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set custom label on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCustomLabel.$2", - "type": "CompoundType", - "tags": [], - "label": "customLabel", - "description": [ - "custom label value. If undefined, custom label is removed" - ], - "signature": [ - "string | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount", - "type": "Function", - "tags": [], - "label": "setFieldCount", - "description": [ - "\nSet field count" - ], - "signature": [ - "(fieldName: string, count: number | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set count on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldCount.$2", - "type": "CompoundType", - "tags": [], - "label": "count", - "description": [ - "count value. If undefined, count is removed" - ], - "signature": [ - "number | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat", - "type": "Function", - "tags": [], - "label": "setFieldFormat", - "description": [ - "\nSet field formatter" - ], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - "SerializableRecord", - ">) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set format on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.setFieldFormat.$2", - "type": "Object", - "tags": [], - "label": "format", - "description": [ - "field format in serialized form" - ], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - "SerializableRecord", - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataView.deleteFieldFormat", - "type": "Function", - "tags": [], - "label": "deleteFieldFormat", - "description": [ - "\nRemove field format from the field format map." - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataView.deleteFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "field name associated with the format for removal" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService", - "type": "Class", - "tags": [], - "label": "DataViewsService", - "description": [ - "\nData views service, providing CRUD operations for data views." - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getCanSave", - "type": "Function", - "tags": [], - "label": "getCanSave", - "description": [ - "\nCan the user save data views?" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nDataViewsService constructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "deps", - "description": [ - "Service dependencies" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsServiceDeps", - "text": "DataViewsServiceDeps" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getIds", - "type": "Function", - "tags": [], - "label": "getIds", - "description": [ - "\nGets list of index pattern ids." - ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getIds.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getTitles", - "type": "Function", - "tags": [], - "label": "getTitles", - "description": [ - "\nGets list of index pattern titles." - ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getTitles.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.find", - "type": "Function", - "tags": [], - "label": "find", - "description": [ - "\nFind and load index patterns by title." - ], - "signature": [ - "(search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.find.$1", - "type": "string", - "tags": [], - "label": "search", - "description": [ - "Search string" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.find.$2", - "type": "number", - "tags": [], - "label": "size", - "description": [ - "Number of data views to return" - ], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "DataView[]" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getIdsWithTitle", - "type": "Function", - "tags": [], - "label": "getIdsWithTitle", - "description": [ - "\nGets list of index pattern ids with titles." - ], - "signature": [ - "(refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getIdsWithTitle.$1", - "type": "boolean", - "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.clearCache", - "type": "Function", - "tags": [], - "label": "clearCache", - "description": [ - "\nClear index pattern list cache." - ], - "signature": [ - "(id?: string | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.clearCache.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "optionally clear a single id" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getCache", - "type": "Function", - "tags": [], - "label": "getCache", - "description": [ - "\nGet cache, contains data view saved objects." - ], - "signature": [ - "() => Promise<", - "SavedObject", - "<", - "DataViewSavedObjectAttrs", - ">[] | null | undefined>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getDefault", - "type": "Function", - "tags": [], - "label": "getDefault", - "description": [ - "\nGet default index pattern" - ], - "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getDefaultId", - "type": "Function", - "tags": [], - "label": "getDefaultId", - "description": [ - "\nGet default index pattern id" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.setDefault", - "type": "Function", - "tags": [], - "label": "setDefault", - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], - "signature": [ - "(id: string | null, force?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.setDefault.$1", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [ - "data view id" - ], - "signature": [ - "string | null" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.setDefault.$2", - "type": "boolean", - "tags": [], - "label": "force", - "description": [ - "set default data view even if there's an existing default" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.hasUserDataView", - "type": "Function", - "tags": [], - "label": "hasUserDataView", - "description": [ - "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getFieldsForWildcard", - "type": "Function", - "tags": [], - "label": "getFieldsForWildcard", - "description": [ - "\nGet field list by providing { pattern }." - ], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getFieldsForWildcard.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "options for getting field list" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getFieldsForIndexPattern", - "type": "Function", - "tags": [], - "label": "getFieldsForIndexPattern", - "description": [ - "\nGet field list by providing an index patttern (or spec)." - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getFieldsForIndexPattern.$1", - "type": "CompoundType", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getFieldsForIndexPattern.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "options for getting field list" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "FieldSpec[]" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.refreshFields", - "type": "Function", - "tags": [], - "label": "refreshFields", - "description": [ - "\nRefresh field list for a given index pattern." - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.refreshFields.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.fieldArrayToMap", - "type": "Function", - "tags": [], - "label": "fieldArrayToMap", - "description": [ - "\nConverts field array to map." - ], - "signature": [ - "(fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.fieldArrayToMap.$1", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - ": FieldSpec[]" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.fieldArrayToMap.$2", - "type": "Object", - "tags": [], - "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "Record" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.savedObjectToSpec", - "type": "Function", - "tags": [], - "label": "savedObjectToSpec", - "description": [ - "\nConverts data view saved object to data view spec." - ], - "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.savedObjectToSpec.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "DataViewSpec" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGet an index pattern by id, cache optimized." - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [ - "\nCreate a new data view instance." - ], - "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.create.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [ - "data view spec" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.create.$2", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [ - "if true, will not fetch fields" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "DataView" - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createAndSave", - "type": "Function", - "tags": [], - "label": "createAndSave", - "description": [ - "\nCreate a new data view and save it right away." - ], - "signature": [ - "(spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createAndSave.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [ - "data view spec" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createAndSave.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createAndSave.$3", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [ - "Whether to skip field refresh step." - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createSavedObject", - "type": "Function", - "tags": [], - "label": "createSavedObject", - "description": [ - "\nSave a new data view." - ], - "signature": [ - "(dataView: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createSavedObject.$1", - "type": "Object", - "tags": [], - "label": "dataView", - "description": [ - "data view instance" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.createSavedObject.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.updateSavedObject", - "type": "Function", - "tags": [], - "label": "updateSavedObject", - "description": [ - "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." - ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.updateSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.updateSavedObject.$2", - "type": "number", - "tags": [], - "label": "saveAttempts", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.updateSavedObject.$3", - "type": "boolean", - "tags": [], - "label": "ignoreErrors", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nDeletes an index pattern from .kibana index." - ], - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.delete.$1", - "type": "string", - "tags": [], - "label": "indexPatternId", - "description": [ - ": Id of kibana Index Pattern to delete" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsService.getDefaultDataView", - "type": "Function", - "tags": [], - "label": "getDefaultDataView", - "description": [ - "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" - ], - "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [ - "default data view" - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher", - "type": "Class", - "tags": [], - "label": "IndexPatternsFetcher", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "elasticsearchClient", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.Unnamed.$2", - "type": "boolean", - "tags": [], - "label": "allowNoIndices", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", - "type": "Function", - "tags": [ - "property", - "property", - "return" - ], - "label": "getFieldsForWildcard", - "description": [ - "\n Get a list of field objects for an index pattern that may contain wildcards\n" - ], - "signature": [ - "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", - "QueryDslQueryContainer", - " | undefined; }) => Promise<", - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.FieldDescriptor", - "text": "FieldDescriptor" - }, - "[]>" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", - "type": "CompoundType", - "tags": [], - "label": "pattern", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", - "type": "Object", - "tags": [], - "label": "fieldCapsOptions", - "description": [], - "signature": [ - "{ allow_no_indices: boolean; } | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", - "type": "string", - "tags": [], - "label": "rollupIndex", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "QueryDslQueryContainer", - " | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive", - "type": "Function", - "tags": [ - "return" - ], - "label": "validatePatternListActive", - "description": [ - "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" - ], - "signature": [ - "(patternList: string[]) => Promise" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", - "type": "Array", - "tags": [], - "label": "patternList", - "description": [ - "string[]" - ], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "data", - "id": "def-server.getCapabilitiesForRollupIndices", - "type": "Function", - "tags": [], - "label": "getCapabilitiesForRollupIndices", - "description": [ - "\nGet rollup job capabilities" - ], - "signature": [ - "(indices: Record) => { [key: string]: any; }" - ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.getCapabilitiesForRollupIndices.$1", - "type": "Object", - "tags": [], - "label": "indices", - "description": [ - "rollup job index capabilites" - ], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KibanaConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getRequestAbortedSignal", - "type": "Function", - "tags": [], - "label": "getRequestAbortedSignal", - "description": [ - "\nA simple utility function that returns an `AbortSignal` corresponding to an `AbortController`\nwhich aborts when the given request is aborted." - ], - "signature": [ - "(aborted$: ", - "Observable", - ") => AbortSignal" - ], - "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.getRequestAbortedSignal.$1", - "type": "Object", - "tags": [], - "label": "aborted$", - "description": [ - "The observable of abort events (usually `request.events.aborted$`)" - ], - "signature": [ - "Observable", - "" - ], - "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.getTime", - "type": "Function", - "tags": [], - "label": "getTime", - "description": [], - "signature": [ - "(indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | undefined, timeRange: ", - "TimeRange", - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.getTime.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-server.getTime.$2", - "type": "Object", - "tags": [], - "label": "timeRange", - "description": [], - "signature": [ - "TimeRange" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-server.getTime.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.getTime.$3.forceNow", - "type": "Object", - "tags": [], - "label": "forceNow", - "description": [], - "signature": [ - "Date | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.getTime.$3.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/query/timefilter/get_time.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart", - "type": "Interface", - "tags": [], - "label": "DataViewsServerPluginStart", - "description": [ - "\nDataViews server plugin start api" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory", - "type": "Function", - "tags": [], - "label": "dataViewsServiceFactory", - "description": [ - "\nReturns a DataViews service instance" - ], - "signature": [ - "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", elasticsearchClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsService", - "text": "DataViewsService" - }, - ">" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$1", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$2", - "type": "Object", - "tags": [], - "label": "elasticsearchClient", - "description": [], - "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; helpers: ", - "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "BulkResponse", - ">; }; cat: ", - "default", - "; ccr: ", - "default", - "; clearScroll: { (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClearScrollResponse", - ">; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClearScrollResponse", - ", unknown>>; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClearScrollResponse", - ">; }; cluster: ", - "default", - "; count: { (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "CountResponse", - ">; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "CountResponse", - ", unknown>>; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "CountResponse", - ">; }; danglingIndices: ", - "default", - "; deleteByQuery: { (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "DeleteByQueryResponse", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; }; deleteByQueryRethrottle: { (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TasksTaskListResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; }; deleteScript: { (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; enrich: ", - "default", - "; exists: { (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; existsSource: { (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; explain: { (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ExplainResponse", - ">; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ExplainResponse", - ", unknown>>; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ExplainResponse", - ">; }; features: ", - "default", - "; fieldCaps: { (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "FieldCapsResponse", - ">; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "FieldCapsResponse", - ", unknown>>; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "FieldCapsResponse", - ">; }; fleet: ", - "default", - "; getScript: { (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptResponse", - ">; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptResponse", - ", unknown>>; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptResponse", - ">; }; getScriptContext: { (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptContextResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; }; getScriptLanguages: { (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptLanguagesResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; }; getSource: { (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; graph: ", - "default", - "; ilm: ", - "default", - "; indices: ", - "default", - "; info: { (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "InfoResponse", - ">; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "InfoResponse", - ", unknown>>; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "InfoResponse", - ">; }; ingest: ", - "default", - "; knnSearch: { (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "KnnSearchResponse", - ">; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "KnnSearchResponse", - ", unknown>>; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "KnnSearchResponse", - ">; }; license: ", - "default", - "; logstash: ", - "default", - "; mget: { (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MgetResponse", - ">; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MgetResponse", - ", unknown>>; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MgetResponse", - ">; }; migration: ", - "default", - "; ml: ", - "default", - "; msearch: { >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchResponse", - ">; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchResponse", - ", unknown>>; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchResponse", - ">; }; msearchTemplate: { >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchTemplateResponse", - ", unknown>>; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; }; mtermvectors: { (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MtermvectorsResponse", - ", unknown>>; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; }; nodes: ", - "default", - "; openPointInTime: { (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "OpenPointInTimeResponse", - ", unknown>>; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; }; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; putScript: { (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; rankEval: { (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RankEvalResponse", - ">; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RankEvalResponse", - ", unknown>>; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RankEvalResponse", - ">; }; reindex: { (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexResponse", - ">; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexResponse", - ", unknown>>; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexResponse", - ">; }; reindexRethrottle: { (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexRethrottleResponse", - ", unknown>>; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; }; renderSearchTemplate: { (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RenderSearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; }; rollup: ", - "default", - "; scriptsPainlessExecute: { (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScriptsPainlessExecuteResponse", - ", unknown>>; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; }; scroll: { >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScrollResponse", - ">; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScrollResponse", - ", unknown>>; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScrollResponse", - ">; }; searchMvt: { (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; searchShards: { (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchShardsResponse", - ">; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchShardsResponse", - ", unknown>>; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchShardsResponse", - ">; }; searchTemplate: { (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; }; searchableSnapshots: ", - "default", - "; shutdown: ", - "default", - "; slm: ", - "default", - "; snapshot: ", - "default", - "; sql: ", - "default", - "; ssl: ", - "default", - "; tasks: ", - "default", - "; termsEnum: { (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermsEnumResponse", - ">; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermsEnumResponse", - ", unknown>>; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermsEnumResponse", - ">; }; termvectors: { (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermvectorsResponse", - ">; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermvectorsResponse", - ", unknown>>; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermvectorsResponse", - ">; }; textStructure: ", - "default", - "; transform: ", - "default", - "; updateByQuery: { (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; }; updateByQueryRethrottle: { (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$3", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$4", - "type": "CompoundType", - "tags": [], - "label": "byPassCapabilities", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor", - "type": "Interface", - "tags": [], - "label": "FieldDescriptor", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.readFromDocValues", - "type": "boolean", - "tags": [], - "label": "readFromDocValues", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.subType", - "type": "Object", - "tags": [], - "label": "subType", - "description": [], - "signature": [ - "FieldSubType | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.FieldDescriptor.metadata_field", - "type": "CompoundType", - "tags": [], - "label": "metadata_field", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IEsSearchRequest", - "type": "Interface", - "tags": [], - "label": "IEsSearchRequest", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchRequest", - "text": "IKibanaSearchRequest" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchRequestParams", - "text": "ISearchRequestParams" - }, - ">" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IEsSearchRequest.indexType", - "type": "string", - "tags": [], - "label": "indexType", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions", - "type": "Interface", - "tags": [], - "label": "ISearchOptions", - "description": [], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.abortSignal", - "type": "Object", - "tags": [], - "label": "abortSignal", - "description": [ - "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." - ], - "signature": [ - "AbortSignal | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.strategy", - "type": "string", - "tags": [], - "label": "strategy", - "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.legacyHitsTotal", - "type": "CompoundType", - "tags": [], - "label": "legacyHitsTotal", - "description": [ - "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.sessionId", - "type": "string", - "tags": [], - "label": "sessionId", - "description": [ - "\nA session ID, grouping multiple search requests into a single session." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.isStored", - "type": "CompoundType", - "tags": [], - "label": "isStored", - "description": [ - "\nWhether the session is already saved (i.e. sent to background)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.isRestore", - "type": "CompoundType", - "tags": [], - "label": "isRestore", - "description": [ - "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.indexPattern", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [ - "\nIndex pattern reference is used for better error messages" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.inspector", - "type": "Object", - "tags": [], - "label": "inspector", - "description": [ - "\nInspector integration options" - ], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IInspectorInfo", - "text": "IInspectorInfo" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.executionContext", - "type": "Object", - "tags": [], - "label": "executionContext", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "data", - "id": "def-server.ES_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "ES_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.KBN_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "KBN_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.METRIC_TYPES", - "type": "Enum", - "tags": [], - "label": "METRIC_TYPES", - "description": [], - "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-server.DEFAULT_QUERY_LANGUAGE", - "type": "string", - "tags": [], - "label": "DEFAULT_QUERY_LANGUAGE", - "description": [], - "signature": [ - "\"kuery\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ES_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"es\"" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.EsQueryConfig", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "EsQueryConfig", - "description": [], - "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.Filter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "Filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.IEsSearchResponse", - "type": "Type", - "tags": [], - "label": "IEsSearchResponse", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "<", - "SearchResponse", - ">>" - ], - "path": "src/plugins/data/common/search/strategies/es_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ParsedInterval", - "type": "Type", - "tags": [], - "label": "ParsedInterval", - "description": [], - "signature": [ - "{ value: number; unit: ", - "Unit", - "; type: \"calendar\" | \"fixed\"; }" - ], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.TimeRange", - "type": "Type", - "tags": [ - "deprecated", - "deprecated" - ], - "label": "TimeRange", - "description": [ - "\n" - ], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/locator.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/locator.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" - }, - { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" - }, - { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" - }, - { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" - }, - { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" - }, - { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" - }, - { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" - }, - { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" - }, - { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" - }, - { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - } - ], - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters", - "type": "Object", - "tags": [], - "label": "esFilters", - "description": [], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter", - "type": "Function", - "tags": [], - "label": "buildQueryFilter", - "description": [], - "signature": [ - "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", - "FilterMeta", - " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$3", - "type": "string", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildQueryFilter.$4", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "FilterMeta", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter", - "type": "Function", - "tags": [], - "label": "buildCustomFilter", - "description": [], - "signature": [ - "(indexPatternString: string, queryDsl: ", - "QueryDslQueryContainer", - ", disabled: boolean, negate: boolean, alias: string | null, store: ", - "FilterStateStore", - ") => ", - "Filter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$1", - "type": "string", - "tags": [], - "label": "indexPatternString", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$2", - "type": "Object", - "tags": [], - "label": "queryDsl", - "description": [], - "signature": [ - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$3", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$5", - "type": "CompoundType", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | null" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildCustomFilter.$6", - "type": "Enum", - "tags": [], - "label": "store", - "description": [], - "signature": [ - "FilterStateStore" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter", - "type": "Function", - "tags": [], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter.$1", - "type": "boolean", - "tags": [], - "label": "isPinned", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildEmptyFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter", - "type": "Function", - "tags": [], - "label": "buildExistsFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", indexPattern: ", - "DataViewBase", - ") => ", - "ExistsFilter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildExistsFilter.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter", - "type": "Function", - "tags": [], - "label": "buildFilter", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - ", field: ", - "DataViewFieldBase", - ", type: ", - "FILTERS", - ", negate: boolean, disabled: boolean, params: ", - "Serializable", - ", alias: string | null, store?: ", - "FilterStateStore", - " | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$2", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$3", - "type": "Enum", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "FILTERS" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$5", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$6", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "string | number | boolean | ", - "SerializableRecord", - " | SerializableArray | null | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$7", - "type": "CompoundType", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | null" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildFilter.$8", - "type": "CompoundType", - "tags": [], - "label": "store", - "description": [], - "signature": [ - "FilterStateStore", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter", - "type": "Function", - "tags": [], - "label": "buildPhraseFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", value: PhraseFilterValue, indexPattern: ", - "DataViewBase", - ") => ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$2", - "type": "CompoundType", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "string | number | boolean" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhraseFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter", - "type": "Function", - "tags": [], - "label": "buildPhrasesFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: PhraseFilterValue[], indexPattern: ", - "DataViewBase", - ") => ", - "PhrasesFilter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$2", - "type": "Array", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "PhraseFilterValue[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildPhrasesFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter", - "type": "Function", - "tags": [], - "label": "buildRangeFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: ", - "RangeFilterParams", - ", indexPattern?: ", - "DataViewBase", - " | undefined, formattedValue?: string | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$2", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "RangeFilterParams" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.buildRangeFilter.$4", - "type": "string", - "tags": [], - "label": "formattedValue", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esFilters.isFilterDisabled", - "type": "Function", - "tags": [], - "label": "isFilterDisabled", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => boolean" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esFilters.isFilterDisabled.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery", - "type": "Object", - "tags": [], - "label": "esKuery", - "description": [], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression", - "type": "Function", - "tags": [], - "label": "fromKueryExpression", - "description": [], - "signature": [ - "(expression: string | ", - "QueryDslQueryContainer", - ", parseOptions?: Partial<", - "KueryParseOptions", - "> | undefined) => ", - "KueryNode" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression.$1", - "type": "CompoundType", - "tags": [], - "label": "expression", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery.fromKueryExpression.$2", - "type": "Object", - "tags": [], - "label": "parseOptions", - "description": [], - "signature": [ - "Partial<", - "KueryParseOptions", - "> | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery", - "type": "Function", - "tags": [], - "label": "toElasticsearchQuery", - "description": [], - "signature": [ - "(node: ", - "KueryNode", - ", indexPattern?: ", - "DataViewBase", - " | undefined, config?: ", - "KueryQueryOptions", - " | undefined, context?: Record | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$1", - "type": "Object", - "tags": [], - "label": "node", - "description": [], - "signature": [ - "KueryNode" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$3", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KueryQueryOptions", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esKuery.toElasticsearchQuery.$4", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery", - "type": "Object", - "tags": [], - "label": "esQuery", - "description": [], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters", - "type": "Function", - "tags": [], - "label": "buildQueryFromFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[] | undefined, indexPattern: ", - "DataViewBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", - "BoolQuery" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$2", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildQueryFromFilters.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "KibanaConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery", - "type": "Function", - "tags": [], - "label": "buildEsQuery", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - " | undefined, queries: ", - "Query", - " | ", - "Query", - "[], filters: ", - "Filter", - " | ", - "Filter", - "[], config?: ", - "EsQueryConfig", - " | undefined) => { bool: ", - "BoolQuery", - "; }" - ], - "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$2", - "type": "CompoundType", - "tags": [], - "label": "queries", - "description": [], - "signature": [ - "Query", - " | ", - "Query", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$3", - "type": "CompoundType", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - " | ", - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.esQuery.buildEsQuery.$4", - "type": "CompoundType", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "EsQueryConfig", - " | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.exporters", - "type": "Object", - "tags": [], - "label": "exporters", - "description": [], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV", - "type": "Function", - "tags": [], - "label": "datatableToCSV", - "description": [], - "signature": [ - "({ columns, rows }: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV.$1", - "type": "Object", - "tags": [], - "label": "__0", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.exporters.datatableToCSV.$2", - "type": "Object", - "tags": [], - "label": "__1", - "description": [], - "signature": [ - "CSVOptions" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.exporters.CSV_MIME_TYPE", - "type": "string", - "tags": [], - "label": "CSV_MIME_TYPE", - "description": [], - "path": "src/plugins/data/server/index.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.CidrMask", - "type": "Object", - "tags": [], - "label": "CidrMask", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CidrMask", - "text": "CidrMask" - } - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.dateHistogramInterval", - "type": "Function", - "tags": [], - "label": "dateHistogramInterval", - "description": [], - "signature": [ - "(interval: string) => Interval" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.dateHistogramInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.IpAddress", - "type": "Object", - "tags": [], - "label": "IpAddress", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IpAddress", - "text": "IpAddress" - } - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.parseInterval", - "type": "Function", - "tags": [], - "label": "parseInterval", - "description": [], - "signature": [ - "(interval: string) => moment.Duration | null" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.parseInterval.$1", - "type": "string", - "tags": [], - "label": "interval", - "description": [], - "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan", - "type": "Function", - "tags": [], - "label": "calcAutoIntervalLessThan", - "description": [], - "signature": [ - "(maxBucketCount: number, duration: number) => moment.Duration" - ], - "path": "src/plugins/data/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan.$1", - "type": "number", - "tags": [], - "label": "maxBucketCount", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.search.aggs.calcAutoIntervalLessThan.$2", - "type": "number", - "tags": [], - "label": "duration", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", - "deprecated": false - } - ] - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.UI_SETTINGS", - "type": "Object", - "tags": [], - "label": "UI_SETTINGS", - "description": [], - "signature": [ - "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "setup": { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup", - "type": "Interface", - "tags": [], - "label": "DataPluginSetup", - "description": [], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "ISearchSetup" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "QuerySetup" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.fieldFormats", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsSetup", - "text": "FieldFormatsSetup" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": true, - "references": [] - } - ], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "data", - "id": "def-server.DataPluginStart", - "type": "Interface", - "tags": [], - "label": "DataPluginStart", - "description": [], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "ISearchStart", - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - ", ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchResponse", - "text": "IEsSearchResponse" - }, - ">" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.fieldFormats", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "server", - "docId": "kibFieldFormatsPluginApi", - "section": "def-server.FieldFormatsStart", - "text": "FieldFormatsStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/plugin.ts" - } - ] - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.indexPatterns", - "type": "Object", - "tags": [], - "label": "indexPatterns", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - } - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.DataPluginStart.datatableUtilities", - "type": "Object", - "tags": [], - "label": "datatableUtilities", - "description": [ - "\nDatatable type utility functions." - ], - "signature": [ - "DatatableUtilitiesService" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - } - ], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService", - "type": "Class", - "tags": [], - "label": "DatatableUtilitiesService", - "description": [], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "aggs", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStart", - "text": "AggsCommonStart" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$2", - "type": "Object", - "tags": [], - "label": "dataViews", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsContract", - "text": "DataViewsContract" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "fieldFormats", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormatsStartCommon", - "text": "FieldFormatsStartCommon" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearField", - "type": "Function", - "tags": [], - "label": "clearField", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearField.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearFieldFormat", - "type": "Function", - "tags": [], - "label": "clearFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.clearFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getAggConfig", - "type": "Function", - "tags": [], - "label": "getAggConfig", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getAggConfig.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta", - "type": "Function", - "tags": [], - "label": "getDateHistogramMeta", - "description": [ - "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", defaults?: Partial<{ timeZone: string; }>) => DateHistogramMeta | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$2", - "type": "Object", - "tags": [], - "label": "defaults", - "description": [], - "signature": [ - "Partial<{ timeZone: string; }>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDataView", - "type": "Function", - "tags": [], - "label": "getDataView", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getDataView.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getField", - "type": "Function", - "tags": [], - "label": "getField", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined>" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getField.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getFieldFormat", - "type": "Function", - "tags": [], - "label": "getFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - " | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getInterval", - "type": "Function", - "tags": [], - "label": "getInterval", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => string | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getInterval.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval", - "type": "Function", - "tags": [], - "label": "getNumberHistogramInterval", - "description": [ - "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." - ], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getTotalCount", - "type": "Function", - "tags": [], - "label": "getTotalCount", - "description": [], - "signature": [ - "(table: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - ") => number | undefined" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.getTotalCount.$1", - "type": "Object", - "tags": [], - "label": "table", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.hasPrecisionError", - "type": "Function", - "tags": [], - "label": "hasPrecisionError", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => ", - "Serializable" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.hasPrecisionError.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ") => boolean" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.isFilterable.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat", - "type": "Function", - "tags": [], - "label": "setFieldFormat", - "description": [], - "signature": [ - "(column: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - ", fieldFormat: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") => void" - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat.$1", - "type": "Object", - "tags": [], - "label": "column", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DatatableUtilitiesService.setFieldFormat.$2", - "type": "Object", - "tags": [], - "label": "fieldFormat", - "description": [], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView", - "type": "Class", - "tags": [], - "label": "DataView", - "description": [ - "\nData view class. Central kibana abstraction around multiple indices." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " implements ", - "DataViewBase" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nSaved object id" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.title", - "type": "string", - "tags": [], - "label": "title", - "description": [ - "\nTitle of data view" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.fieldFormatMap", - "type": "Object", - "tags": [], - "label": "fieldFormatMap", - "description": [ - "\nMap of field formats by field name" - ], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.typeMeta", - "type": "Object", - "tags": [], - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.fields", - "type": "CompoundType", - "tags": [], - "label": "fields", - "description": [ - "\nField list, in extended array format" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [ - "\nTimestamp field name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nType is used to identify rollup index patterns." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.flattenHit", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "flattenHit", - "description": [], - "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - } - ], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.flattenHit.$1", - "type": "Object", - "tags": [], - "label": "hit", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.flattenHit.$2", - "type": "CompoundType", - "tags": [], - "label": "deep", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.metaFields", - "type": "Array", - "tags": [], - "label": "metaFields", - "description": [ - "\nList of meta fields by name" - ], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nSavedObject version" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.sourceFilters", - "type": "Array", - "tags": [], - "label": "sourceFilters", - "description": [ - "\nArray of filters - hides fields in discover" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nArray of namespace ids" - ], - "signature": [ - "string[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.allowNoIndex", - "type": "boolean", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nPrevents errors when index pattern exists before indices" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the data view. Human readable name used to differentiate data view." - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nconstructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [ - "- config data and dependencies" - ], - "signature": [ - "DataViewDeps" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getName", - "type": "Function", - "tags": [], - "label": "getName", - "description": [ - "\nGet name of Data View" - ], - "signature": [ - "() => string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getOriginalSavedObjectBody", - "description": [ - "\nGet last saved saved object fields" - ], - "signature": [ - "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.resetOriginalSavedObjectBody", - "type": "Function", - "tags": [], - "label": "resetOriginalSavedObjectBody", - "description": [ - "\nReset last saved saved object fields. Used after saving." - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldAttrs", - "type": "Function", - "tags": [], - "label": "getFieldAttrs", - "description": [ - "\nReturns field attributes map" - ], - "signature": [ - "() => { [x: string]: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getComputedFields", - "type": "Function", - "tags": [], - "label": "getComputedFields", - "description": [ - "\nReturns scripted fields" - ], - "signature": [ - "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", - "MappingRuntimeFields", - "; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nCreates static representation of the data view." - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getSourceFiltering", - "type": "Function", - "tags": [], - "label": "getSourceFiltering", - "description": [ - "\nGet the source filtering configuration for that index." - ], - "signature": [ - "() => { excludes: string[]; }" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.removeScriptedField", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "removeScriptedField", - "description": [ - "\nRemoves scripted field from field list." - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.removeScriptedField.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of scripted field to remove" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getNonScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getNonScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getScriptedFields", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getScriptedFields", - "description": [ - "\n" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": true, - "references": [ - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_views.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, - { - "plugin": "dataViewManagement", - "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.test.ts" - } - ], - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.isTimeBased", - "type": "Function", - "tags": [], - "label": "isTimeBased", - "description": [ - "\nDoes the data view have a timestamp field?" - ], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.isTimeNanosBased", - "type": "Function", - "tags": [], - "label": "isTimeNanosBased", - "description": [ - "\nDoes the data view have a timestamp field and is it a date nanos field?" - ], - "signature": [ - "() => this is ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TimeBasedDataView", - "text": "TimeBasedDataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getTimeField", - "type": "Function", - "tags": [], - "label": "getTimeField", - "description": [ - "\nGet timestamp field as DataViewField or return undefined" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldByName", - "type": "Function", - "tags": [], - "label": "getFieldByName", - "description": [ - "\nGet field by name." - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getAggregationRestrictions", - "type": "Function", - "tags": [], - "label": "getAggregationRestrictions", - "description": [ - "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." - ], - "signature": [ - "() => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getAsSavedObjectBody", - "type": "Function", - "tags": [], - "label": "getAsSavedObjectBody", - "description": [ - "\nReturns index pattern as saved object body for saving" - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [ - "\nProvide a field, get its formatter" - ], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForField.$1", - "type": "CompoundType", - "tags": [], - "label": "field", - "description": [ - "field to get formatter for" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField", - "type": "Function", - "tags": [], - "label": "addRuntimeField", - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." - ], - "signature": [ - "(name: string, runtimeField: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - ") => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "Field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.addRuntimeField.$2", - "type": "Object", - "tags": [], - "label": "runtimeField", - "description": [ - "Runtime field definition" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - } - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.hasRuntimeField", - "type": "Function", - "tags": [], - "label": "hasRuntimeField", - "description": [ - "\nChecks if runtime field exists" - ], - "signature": [ - "(name: string) => boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.hasRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeField", - "type": "Function", - "tags": [], - "label": "getRuntimeField", - "description": [ - "\nReturns runtime field if exists" - ], - "signature": [ - "(name: string) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | null" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "Runtime field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "getAllRuntimeFields", - "description": [ - "\nGet all runtime field definitions." - ], - "signature": [ - "() => Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [ - "map of runtime field definitions by field name" - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldsByRuntimeFieldName", - "type": "Function", - "tags": [], - "label": "getFieldsByRuntimeFieldName", - "description": [ - "\nReturns data view fields backed by runtime fields." - ], - "signature": [ - "(name: string) => Record | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "runtime field name" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "map of DataViewFields (that are runtime fields) by field name" - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.replaceAllRuntimeFields", - "type": "Function", - "tags": [], - "label": "replaceAllRuntimeFields", - "description": [ - "\nReplaces all existing runtime fields with new fields." - ], - "signature": [ - "(newFields: Record) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.replaceAllRuntimeFields.$1", - "type": "Object", - "tags": [], - "label": "newFields", - "description": [ - "Map of runtime field definitions by field name" - ], - "signature": [ - "Record" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.removeRuntimeField", - "type": "Function", - "tags": [], - "label": "removeRuntimeField", - "description": [ - "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." - ], - "signature": [ - "(name: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.removeRuntimeField.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "- Field name to remove" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getRuntimeMappings", - "type": "Function", - "tags": [], - "label": "getRuntimeMappings", - "description": [ - "\nReturn the \"runtime_mappings\" section of the ES search query." - ], - "signature": [ - "() => ", - "MappingRuntimeFields" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForFieldNoDefault", - "type": "Function", - "tags": [], - "label": "getFormatterForFieldNoDefault", - "description": [ - "\nGet formatter for a given field name. Return undefined if none exists." - ], - "signature": [ - "(fieldname: string) => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", - "type": "string", - "tags": [], - "label": "fieldname", - "description": [ - "name of field to get formatter for" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs", - "type": "Function", - "tags": [], - "label": "setFieldAttrs", - "description": [ - "\nSet field attribute" - ], - "signature": [ - "(fieldName: string, attrName: K, value: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set attribute on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$2", - "type": "Uncategorized", - "tags": [], - "label": "attrName", - "description": [ - "name of attribute to set" - ], - "signature": [ - "K" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldAttrs.$3", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [ - "value of attribute" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel", - "type": "Function", - "tags": [], - "label": "setFieldCustomLabel", - "description": [ - "\nSet field custom label" - ], - "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set custom label on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCustomLabel.$2", - "type": "CompoundType", - "tags": [], - "label": "customLabel", - "description": [ - "custom label value. If undefined, custom label is removed" - ], - "signature": [ - "string | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount", - "type": "Function", - "tags": [], - "label": "setFieldCount", - "description": [ - "\nSet field count" - ], - "signature": [ - "(fieldName: string, count: number | null | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set count on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldCount.$2", - "type": "CompoundType", - "tags": [], - "label": "count", - "description": [ - "count value. If undefined, count is removed" - ], - "signature": [ - "number | null | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat", - "type": "Function", - "tags": [], - "label": "setFieldFormat", - "description": [ - "\nSet field formatter" - ], - "signature": [ - "(fieldName: string, format: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - "SerializableRecord", - ">) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "name of field to set format on" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.setFieldFormat.$2", - "type": "Object", - "tags": [], - "label": "format", - "description": [ - "field format in serialized form" - ], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - "SerializableRecord", - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataView.deleteFieldFormat", - "type": "Function", - "tags": [], - "label": "deleteFieldFormat", - "description": [ - "\nRemove field format from the field format map." - ], - "signature": [ - "(fieldName: string) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataView.deleteFieldFormat.$1", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "field name associated with the format for removal" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_view.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField", - "type": "Class", - "tags": [], - "label": "DataViewField", - "description": [ - "\nData view field class" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - " implements ", - "DataViewFieldBase" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewField.spec", - "type": "CompoundType", - "tags": [], - "label": "spec", - "description": [], - "signature": [ - "DataViewFieldBase", - " & { count?: number | undefined; conflictDescriptions?: Record | undefined; format?: ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<", - "SerializableRecord", - "> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; runtimeField?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.Unnamed", - "type": "Function", - "tags": [ - "constructor" - ], - "label": "Constructor", - "description": [ - "\nDataView constructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewField.Unnamed.$1", - "type": "CompoundType", - "tags": [], - "label": "spec", - "description": [ - "Configuration for the field" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nCount is used for field popularity in discover." - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nSet count, which is used for field popularity in discover." - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.runtimeField", - "type": "CompoundType", - "tags": [], - "label": "runtimeField", - "description": [ - "\nReturns runtime field definition or undefined if field is not runtime field." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.runtimeField", - "type": "CompoundType", - "tags": [], - "label": "runtimeField", - "description": [ - "\nSets runtime field definition or unsets if undefined is provided." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [ - "\nScript field code" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.script", - "type": "string", - "tags": [], - "label": "script", - "description": [ - "\nSets scripted field painless code" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [ - "\nScript field language" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.lang", - "type": "string", - "tags": [], - "label": "lang", - "description": [ - "\nSets scripted field langauge." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [ - "\nReturns custom label if set, otherwise undefined." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [ - "\nSets custom label for field, or unsets if passed undefined." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.conflictDescriptions", - "type": "Object", - "tags": [], - "label": "conflictDescriptions", - "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern." - ], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.conflictDescriptions", - "type": "Object", - "tags": [], - "label": "conflictDescriptions", - "description": [ - "\nSets conflict descriptions for field." - ], - "signature": [ - "Record | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nGet field name" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [ - "\nGets display name, calcualted based on name, custom label and shortDotsEnable." - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nGets field type" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [ - "\nGets ES types as string array" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.scripted", - "type": "boolean", - "tags": [], - "label": "scripted", - "description": [ - "\nReturns true if scripted field" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.searchable", - "type": "boolean", - "tags": [], - "label": "searchable", - "description": [ - "\nReturns true if field is searchable" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.aggregatable", - "type": "boolean", - "tags": [], - "label": "aggregatable", - "description": [ - "\nReturns true if field is aggregatable" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.readFromDocValues", - "type": "boolean", - "tags": [], - "label": "readFromDocValues", - "description": [ - "\nReturns true if field is available via doc values" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.subType", - "type": "CompoundType", - "tags": [], - "label": "subType", - "description": [ - "\nReturns field subtype, multi, nested, or undefined if neither" - ], - "signature": [ - "IFieldSubType", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isMapped", - "type": "CompoundType", - "tags": [], - "label": "isMapped", - "description": [ - "\nIs the field part of the index mapping?" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isRuntimeField", - "type": "boolean", - "tags": [], - "label": "isRuntimeField", - "description": [ - "\nReturns true if runtime field defined on data view" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [ - "\nReturns true if field is sortable" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [ - "\nReturns true if field is filterable" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.visualizable", - "type": "boolean", - "tags": [], - "label": "visualizable", - "description": [ - "\nReturns true if field is visualizable" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isSubtypeNested", - "type": "Function", - "tags": [], - "label": "isSubtypeNested", - "description": [ - "\nReturns true if field is subtype nested" - ], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isSubtypeMulti", - "type": "Function", - "tags": [], - "label": "isSubtypeMulti", - "description": [ - "\nReturns true if field is subtype multi" - ], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.getSubtypeNested", - "type": "Function", - "tags": [], - "label": "getSubtypeNested", - "description": [ - "\nReturns subtype nested data if exists" - ], - "signature": [ - "() => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.getSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getSubtypeMulti", - "description": [ - "\nReturns subtype multi data if exists" - ], - "signature": [ - "() => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.deleteCount", - "type": "Function", - "tags": [], - "label": "deleteCount", - "description": [ - "\nDeletes count value. Popularity as used by discover" - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, + "parentPluginId": "data", + "id": "def-public.indexPatterns.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [], + "signature": [ + "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.indexPatterns.validate.$1", + "type": "string", + "tags": [], + "label": "indexPattern", + "description": [], + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewField.toJSON", - "type": "Function", + "id": "def-public.search.aggs", + "type": "Object", "tags": [], - "label": "toJSON", - "description": [ - "\nJSON version of field" - ], - "signature": [ - "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", - "IFieldSubType", - " | undefined; customLabel: string | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "label": "aggs", + "description": [], + "path": "src/plugins/data/public/index.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [ - "\nGet field in serialized form - fieldspec." - ], - "signature": [ - "(config?: ", + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.CidrMask", + "type": "Object", + "tags": [], + "label": "CidrMask", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.dateHistogramInterval", + "type": "Function", + "tags": [], + "label": "dateHistogramInterval", + "description": [], + "signature": [ + "(interval: string) => Interval" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.dateHistogramInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.intervalOptions", + "type": "Array", + "tags": [], + "label": "intervalOptions", + "description": [], + "signature": [ + "({ display: string; val: string; enabled(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + "): boolean; } | { display: string; val: string; })[]" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.InvalidEsCalendarIntervalError", + "type": "Object", + "tags": [], + "label": "InvalidEsCalendarIntervalError", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.InvalidEsIntervalFormatError", + "type": "Object", + "tags": [], + "label": "InvalidEsIntervalFormatError", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.IpAddress", + "type": "Object", + "tags": [], + "label": "IpAddress", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IpAddress", + "text": "IpAddress" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isDateHistogramBucketAggConfig", + "type": "Function", + "tags": [], + "label": "isDateHistogramBucketAggConfig", + "description": [], + "signature": [ + "(agg: any) => agg is ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketDateHistogramAggConfig", + "text": "IBucketDateHistogramAggConfig" + } + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isDateHistogramBucketAggConfig.$1", + "type": "Any", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isNumberType", + "type": "Function", + "tags": [], + "label": "isNumberType", + "description": [], + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isNumberType.$1", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isStringType", + "type": "Function", + "tags": [], + "label": "isStringType", + "description": [], + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isStringType.$1", + "type": "Object", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isType", + "type": "Function", + "tags": [], + "label": "isType", + "description": [], + "signature": [ + "(...types: string[]) => (agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isType.$1", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "deprecated": false + } + ] + }, { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.ToSpecConfig", - "text": "ToSpecConfig" + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidEsInterval", + "type": "Function", + "tags": [], + "label": "isValidEsInterval", + "description": [], + "signature": [ + "(interval: string) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidEsInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "deprecated": false + } + ] }, - ") => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [ + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval", + "type": "Function", + "tags": [], + "label": "isValidInterval", + "description": [], + "signature": [ + "(value: string, baseInterval?: string | undefined) => boolean" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval.$1", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.isValidInterval.$2", + "type": "string", + "tags": [], + "label": "baseInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "deprecated": false + } + ] + }, { "parentPluginId": "data", - "id": "def-common.DataViewField.toSpec.$1", - "type": "Object", + "id": "def-public.search.aggs.parentPipelineType", + "type": "string", "tags": [], - "label": "config", - "description": [ - "provide a method to get a field formatter" + "label": "parentPipelineType", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseEsInterval", + "type": "Function", + "tags": [], + "label": "parseEsInterval", + "description": [], + "signature": [ + "(interval: string) => { value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseEsInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.parseInterval", + "type": "Function", + "tags": [], + "label": "parseInterval", + "description": [], "signature": [ + "(interval: string) => moment.Duration | null" + ], + "path": "src/plugins/data/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.ToSpecConfig", - "text": "ToSpecConfig" + "parentPluginId": "data", + "id": "def-public.search.aggs.parseInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.propFilter", + "type": "Function", + "tags": [], + "label": "propFilter", + "description": [], + "signature": [ + "

(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "path": "src/plugins/data/public/index.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "field in serialized form - field spec" - ] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewField.isRuntimeCompositeSubField", - "type": "Function", - "tags": [], - "label": "isRuntimeCompositeSubField", - "description": [ - "\nReturns true if composite runtime field" - ], - "signature": [ - "() => boolean" - ], - "path": "src/plugins/data_views/common/fields/data_view_field.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError", - "type": "Class", - "tags": [], - "label": "DataViewSavedObjectConflictError", - "description": [ - "\nError thrown when saved object has been changed when attempting to save." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSavedObjectConflictError", - "text": "DataViewSavedObjectConflictError" - }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nconstructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "children": [ + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.propFilter.$1", + "type": "Uncategorized", + "tags": [], + "label": "prop", + "description": [], + "signature": [ + "P" + ], + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "deprecated": false + } + ] + }, { "parentPluginId": "data", - "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", + "id": "def-public.search.aggs.siblingPipelineType", "type": "string", "tags": [], - "label": "savedObjectId", - "description": [ - "saved object id with conflict" - ], + "label": "siblingPipelineType", + "description": [], + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.aggs.termsAggFilter", + "type": "Array", + "tags": [], + "label": "termsAggFilter", + "description": [], "signature": [ - "string" + "string[]" ], - "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService", - "type": "Class", - "tags": [], - "label": "DataViewsService", - "description": [ - "\nData views service, providing CRUD operations for data views." - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getCanSave", - "type": "Function", - "tags": [], - "label": "getCanSave", - "description": [ - "\nCan the user save data views?" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nDataViewsService constructor" - ], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data/public/index.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.Unnamed.$1", - "type": "Object", + "id": "def-public.search.aggs.toAbsoluteDates", + "type": "Function", "tags": [], - "label": "deps", - "description": [ - "Service dependencies" - ], + "label": "toAbsoluteDates", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewsServiceDeps", - "text": "DataViewsServiceDeps" - } + "(range: ", + "TimeRange", + ") => { from: Date; to: Date; } | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/public/index.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getIds", - "type": "Function", - "tags": [], - "label": "getIds", - "description": [ - "\nGets list of index pattern ids." - ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.search.aggs.toAbsoluteDates.$1", + "type": "Object", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "deprecated": false + } + ] + }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getIds.$1", - "type": "boolean", + "id": "def-public.search.aggs.boundsDescendingRaw", + "type": "Array", "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "label": "boundsDescendingRaw", + "description": [], "signature": [ - "boolean" + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/index.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getTitles", + "id": "def-public.search.getResponseInspectorStats", "type": "Function", "tags": [], - "label": "getTitles", - "description": [ - "\nGets list of index pattern titles." - ], + "label": "getResponseInspectorStats", + "description": [], "signature": [ - "(refresh?: boolean) => Promise" + "(resp?: ", + "SearchResponse", + "> | undefined, searchSource?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined) => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestStatistics", + "text": "RequestStatistics" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/public/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getTitles.$1", - "type": "boolean", + "id": "def-public.search.getResponseInspectorStats.$1", + "type": "Object", "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" + "label": "resp", + "description": [], + "signature": [ + "SearchResponse", + "> | undefined" ], + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.getResponseInspectorStats.$2", + "type": "Object", + "tags": [], + "label": "searchSource", + "description": [], "signature": [ - "boolean" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchSource", + "text": "ISearchSource" + }, + " | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.find", + "id": "def-public.search.tabifyAggResponse", "type": "Function", "tags": [], - "label": "find", - "description": [ - "\nFind and load index patterns by title." - ], + "label": "tabifyAggResponse", + "description": [], "signature": [ - "(search: string, size?: number) => Promise<", + "(aggConfigs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + ", esResponse: Record, respOpts?: Partial<", + "TabbedResponseWriterOptions", + "> | undefined) => ", { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/public/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.find.$1", - "type": "string", + "id": "def-public.search.tabifyAggResponse.$1", + "type": "Object", "tags": [], - "label": "search", - "description": [ - "Search string" - ], + "label": "aggConfigs", + "description": [], "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.find.$2", - "type": "number", + "id": "def-public.search.tabifyAggResponse.$2", + "type": "Object", "tags": [], - "label": "size", - "description": [ - "Number of data views to return" + "label": "esResponse", + "description": [], + "signature": [ + "{ [x: string]: any; }" ], + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.tabifyAggResponse.$3", + "type": "Object", + "tags": [], + "label": "respOpts", + "description": [], "signature": [ - "number" + "Partial<", + "TabbedResponseWriterOptions", + "> | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/search/tabify/tabify.ts", + "deprecated": false } - ], - "returnComment": [ - "DataView[]" ] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getIdsWithTitle", + "id": "def-public.search.tabifyGetColumns", "type": "Function", "tags": [], - "label": "getIdsWithTitle", - "description": [ - "\nGets list of index pattern ids with titles." - ], + "label": "tabifyGetColumns", + "description": [], "signature": [ - "(refresh?: boolean) => Promise<", + "(aggs: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - "[]>" + "[], minimalColumns: boolean) => ", + "TabbedAggColumn", + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/public/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getIdsWithTitle.$1", - "type": "boolean", + "id": "def-public.search.tabifyGetColumns.$1", + "type": "Array", "tags": [], - "label": "refresh", - "description": [ - "Force refresh of index pattern list" - ], + "label": "aggs", + "description": [], "signature": [ - "boolean" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.search.tabifyGetColumns.$2", + "type": "boolean", + "tags": [], + "label": "minimalColumns", + "description": [], + "path": "src/plugins/data/common/search/tabify/get_columns.ts", + "deprecated": false } - ], - "returnComment": [] - }, + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.UI_SETTINGS", + "type": "Object", + "tags": [], + "label": "UI_SETTINGS", + "description": [], + "signature": [ + "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "setup": { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataPublicPluginSetup", + "description": [ + "\nData plugin public Setup contract" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchSetup", + "text": "ISearchSetup" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginSetup.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart", + "type": "Interface", + "tags": [], + "label": "DataPublicPluginStart", + "description": [ + "\nData plugin public Start contract" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.actions", + "type": "Object", + "tags": [], + "label": "actions", + "description": [ + "\nfilter creation utilities\n{@link DataPublicPluginStartActions}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStartActions", + "text": "DataPublicPluginStartActions" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [ + "\ndata views service\n{@link DataViewsContract}" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.datatableUtilities", + "type": "Object", + "tags": [], + "label": "datatableUtilities", + "description": [ + "\nDatatable type utility functions." + ], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.DatatableUtilitiesService", + "text": "DatatableUtilitiesService" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.indexPatterns", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "indexPatterns", + "description": [ + "\nindex patterns service\n{@link DataViewsContract}" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/plugin.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/kibana_services.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/plugin.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" + }, + { + "plugin": "inputControlVis", + "path": "src/plugins/input_control_vis/public/components/editor/controls_tab.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [ + "\nsearch service\n{@link ISearchStart}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchStart", + "text": "ISearchStart" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.fieldFormats", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatsRegistry", + "text": "FieldFormatsRegistry" + }, + ", \"init\" | \"register\"> & { deserialize: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FormatFactory", + "text": "FormatFactory" + }, + "; }" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/actions/export_csv_action.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts" + }, + { + "plugin": "visTypeTable", + "path": "src/plugins/vis_types/table/public/plugin.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/plugin.ts" + }, + { + "plugin": "visTypeXy", + "path": "src/plugins/vis_types/xy/public/plugin.ts" + }, + { + "plugin": "visTypeVislib", + "path": "src/plugins/vis_types/vislib/public/plugin.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + }, + { + "plugin": "expressionPartitionVis", + "path": "src/plugins/chart_expressions/expression_partition_vis/public/utils/layers/get_layers.test.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [ + "\nquery service\n{@link QueryStart}" + ], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStart", + "text": "QueryStart" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.DataPublicPluginStart.nowProvider", + "type": "Object", + "tags": [], + "label": "nowProvider", + "description": [], + "signature": [ + "{ get: () => Date; }" + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin", + "type": "Class", + "tags": [], + "label": "DataServerPlugin", + "description": [], + "signature": [ { - "parentPluginId": "data", - "id": "def-common.DataViewsService.clearCache", - "type": "Function", - "tags": [], - "label": "clearCache", - "description": [ - "\nClear index pattern list cache." - ], - "signature": [ - "(id?: string | undefined) => void" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.clearCache.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "optionally clear a single id" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataServerPlugin", + "text": "DataServerPlugin" }, + " implements ", { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getCache", - "type": "Function", - "tags": [], - "label": "getCache", - "description": [ - "\nGet cache, contains data view saved objects." - ], - "signature": [ - "() => Promise<", - "SavedObject", - "<", - "DataViewSavedObjectAttrs", - ">[] | null | undefined>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, + "<", { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefault", - "type": "Function", - "tags": [], - "label": "getDefault", - "description": [ - "\nGet default index pattern" - ], - "signature": [ - "() => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginSetup", + "text": "DataPluginSetup" }, + ", ", { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefaultId", - "type": "Function", - "tags": [], - "label": "getDefaultId", - "description": [ - "\nGet default index pattern id" - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" }, + ", ", + "DataPluginSetupDependencies", + ", ", + "DataPluginStartDependencies", + ">" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault", + "id": "def-server.DataServerPlugin.Unnamed", "type": "Function", "tags": [], - "label": "setDefault", - "description": [ - "\nOptionally set default index pattern, unless force = true" - ], + "label": "Constructor", + "description": [], "signature": [ - "(id: string | null, force?: boolean) => Promise" + "any" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault.$1", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [ - "data view id" - ], - "signature": [ - "string | null" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.setDefault.$2", - "type": "boolean", + "id": "def-server.DataServerPlugin.Unnamed.$1", + "type": "Object", "tags": [], - "label": "force", - "description": [ - "set default data view even if there's an existing default" - ], + "label": "initializerContext", + "description": [], "signature": [ - "boolean" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "isRequired": true } @@ -25227,573 +11229,723 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.hasUserDataView", - "type": "Function", - "tags": [], - "label": "hasUserDataView", - "description": [ - "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." - ], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForWildcard", + "id": "def-server.DataServerPlugin.setup", "type": "Function", "tags": [], - "label": "getFieldsForWildcard", - "description": [ - "\nGet field list by providing { pattern }." - ], + "label": "setup", + "description": [], "signature": [ - "(options: ", + "(core: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" }, - ") => Promise<", + "<", + "DataPluginStartDependencies", + ", ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ", + "DataPluginSetupDependencies", + ") => { search: ", + "ISearchSetup", + "; query: ", + "QuerySetup", + "; fieldFormats: ", + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsSetup", + "text": "FieldFormatsSetup" }, - "[]>" + "; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForWildcard.$1", + "id": "def-server.DataServerPlugin.setup.$1", "type": "Object", "tags": [], - "label": "options", - "description": [ - "options for getting field list" - ], + "label": "core", + "description": [], "signature": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + "DataPluginStartDependencies", + ", ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataPluginApi", + "section": "def-server.DataPluginStart", + "text": "DataPluginStart" + }, + ">" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.setup.$2", + "type": "Object", + "tags": [], + "label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }", + "description": [], + "signature": [ + "DataPluginSetupDependencies" + ], + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern", + "id": "def-server.DataServerPlugin.start", "type": "Function", "tags": [], - "label": "getFieldsForIndexPattern", - "description": [ - "\nGet field list by providing an index patttern (or spec)." - ], + "label": "start", + "description": [], "signature": [ - "(indexPattern: ", + "(core: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" }, - " | ", + ", { fieldFormats, dataViews, taskManager }: ", + "DataPluginStartDependencies", + ") => { datatableUtilities: ", + "DatatableUtilitiesService", + "; search: ", + "ISearchStart", + "<", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" }, - ", options?: ", + ", ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" }, - " | undefined) => Promise<", + ">; fieldFormats: ", + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsStart", + "text": "FieldFormatsStart" + }, + "; indexPatterns: ", { "pluginId": "dataViews", - "scope": "common", + "scope": "server", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" }, - "[]>" + "; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", - "type": "CompoundType", + "id": "def-server.DataServerPlugin.start.$1", + "type": "Object", "tags": [], - "label": "indexPattern", + "label": "core", "description": [], "signature": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", + "id": "def-server.DataServerPlugin.start.$2", "type": "Object", "tags": [], - "label": "options", - "description": [ - "options for getting field list" - ], + "label": "{ fieldFormats, dataViews, taskManager }", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" + "DataPluginStartDependencies" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data/server/plugin.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataServerPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView", + "type": "Class", + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " implements ", + "DataViewBase" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nTitle of data view" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.fieldFormatMap", + "type": "Object", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nMap of field formats by field name" + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.refreshFields", - "type": "Function", + "id": "def-server.DataView.typeMeta", + "type": "Object", "tags": [], - "label": "refreshFields", + "label": "typeMeta", "description": [ - "\nRefresh field list for a given index pattern." + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." ], "signature": [ - "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.TypeMeta", + "text": "TypeMeta" }, - ") => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.refreshFields.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + " | undefined" ], - "returnComment": [] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap", - "type": "Function", + "id": "def-server.DataView.fields", + "type": "CompoundType", "tags": [], - "label": "fieldArrayToMap", + "label": "fields", "description": [ - "\nConverts field array to map." + "\nField list, in extended array format" ], "signature": [ - "(fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" }, - " | undefined) => ", + " & { toSpec: () => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewFieldMap", "text": "DataViewFieldMap" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTimestamp field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.flattenHit", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "flattenHit", + "description": [], + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap.$1", - "type": "Array", + "id": "def-server.DataView.flattenHit.$1", + "type": "Object", "tags": [], - "label": "fields", - "description": [ - ": FieldSpec[]" - ], + "label": "hit", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "{ [x: string]: any; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.fieldArrayToMap.$2", - "type": "Object", + "id": "def-server.DataView.flattenHit.$2", + "type": "CompoundType", "tags": [], - "label": "fieldAttrs", - "description": [ - ": FieldAttrs" - ], + "label": "deep", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false } + ] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [ + "\nList of meta fields by name" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nSavedObject version" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nArray of filters - hides fields in discover" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.allowNoIndex", + "type": "boolean", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" ], - "returnComment": [ - "Record" - ] + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.savedObjectToSpec", + "id": "def-server.DataView.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the data view. Human readable name used to differentiate data view." + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.Unnamed", "type": "Function", "tags": [], - "label": "savedObjectToSpec", + "label": "Constructor", "description": [ - "\nConverts data view saved object to data view spec." + "\nconstructor" ], "signature": [ - "(savedObject: ", - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } + "any" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.savedObjectToSpec.$1", + "id": "def-server.DataView.Unnamed.$1", "type": "Object", "tags": [], - "label": "savedObject", - "description": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], "signature": [ - "SavedObject", - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">" + "DataViewDeps" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "DataViewSpec" - ] + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.get", + "id": "def-server.DataView.getName", "type": "Function", "tags": [], - "label": "get", + "label": "getName", "description": [ - "\nGet an index pattern by id, cache optimized." + "\nGet name of Data View" ], "signature": [ - "(id: string) => Promise<", + "() => string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.getOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getOriginalSavedObjectBody", + "description": [ + "\nGet last saved saved object fields" + ], + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.resetOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "resetOriginalSavedObjectBody", + "description": [ + "\nReset last saved saved object fields. Used after saving." + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.getFieldAttrs", + "type": "Function", + "tags": [], + "label": "getFieldAttrs", + "description": [ + "\nReturns field attributes map" + ], + "signature": [ + "() => { [x: string]: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - ">" + "; }" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.getComputedFields", + "type": "Function", + "tags": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" + ], + "signature": [ + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.create", + "id": "def-server.DataView.toSpec", "type": "Function", "tags": [], - "label": "create", + "label": "toSpec", "description": [ - "\nCreate a new data view instance." + "\nCreates static representation of the data view." ], "signature": [ - "(spec: ", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewSpec", "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.create.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [ - "data view spec" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.create.$2", - "type": "boolean", - "tags": [], - "label": "skipFetchFields", - "description": [ - "if true, will not fetch fields" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.getSourceFiltering", + "type": "Function", + "tags": [], + "label": "getSourceFiltering", + "description": [ + "\nGet the source filtering configuration for that index." ], - "returnComment": [ - "DataView" - ] + "signature": [ + "() => { excludes: string[]; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave", + "id": "def-server.DataView.removeScriptedField", "type": "Function", - "tags": [], - "label": "createAndSave", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", "description": [ - "\nCreate a new data view and save it right away." + "\nRemoves scripted field from field list." ], "signature": [ - "(spec: ", + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" }, - ">" + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$1", - "type": "Object", - "tags": [], - "label": "spec", - "description": [ - "data view spec" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsService.createAndSave.$3", - "type": "boolean", + "id": "def-server.DataView.removeScriptedField.$1", + "type": "string", "tags": [], - "label": "skipFetchFields", + "label": "fieldName", "description": [ - "Whether to skip field refresh step." + "name of scripted field to remove" ], "signature": [ - "boolean" + "string" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "isRequired": true } @@ -25802,2595 +11954,2540 @@ }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject", + "id": "def-server.DataView.getNonScriptedFields", "type": "Function", - "tags": [], - "label": "createSavedObject", + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", "description": [ - "\nSave a new data view." + "\n" ], "signature": [ - "(dataView: ", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - ", override?: boolean) => Promise<", + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" }, - ">" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ { - "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject.$1", - "type": "Object", - "tags": [], - "label": "dataView", - "description": [ - "data view instance" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataViewsService.createSavedObject.$2", - "type": "boolean", - "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" } ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject", + "id": "def-server.DataView.getScriptedFields", "type": "Function", - "tags": [], - "label": "updateSavedObject", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", "description": [ - "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + "\n" ], "signature": [ - "(indexPattern: ", + "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "section": "def-common.DataViewField", + "text": "DataViewField" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ { - "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_views.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" }, { - "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$2", - "type": "number", - "tags": [], - "label": "saveAttempts", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" }, { - "parentPluginId": "data", - "id": "def-common.DataViewsService.updateSavedObject.$3", - "type": "boolean", - "tags": [], - "label": "ignoreErrors", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" } ], + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.delete", + "id": "def-server.DataView.isTimeBased", "type": "Function", "tags": [], - "label": "delete", + "label": "isTimeBased", "description": [ - "\nDeletes an index pattern from .kibana index." + "\nDoes the data view have a timestamp field?" ], "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "children": [ + "() => this is ", { - "parentPluginId": "data", - "id": "def-common.DataViewsService.delete.$1", - "type": "string", - "tags": [], - "label": "indexPatternId", - "description": [ - ": Id of kibana Index Pattern to delete" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "isRequired": true + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" } ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.DataViewsService.getDefaultDataView", + "id": "def-server.DataView.isTimeNanosBased", "type": "Function", "tags": [], - "label": "getDefaultDataView", + "label": "isTimeNanosBased", "description": [ - "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + "\nDoes the data view have a timestamp field and is it a date nanos field?" ], "signature": [ - "() => Promise<", + "() => this is ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>" + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [], - "returnComment": [ - "default data view" - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError", - "type": "Class", - "tags": [], - "label": "DuplicateDataViewError", - "description": [ - "\nError thrown when attempting to create duplicate index pattern based on title." - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DuplicateDataViewError", - "text": "DuplicateDataViewError" + "returnComment": [] }, - " extends Error" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError.Unnamed", + "id": "def-server.DataView.getTimeField", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getTimeField", "description": [ - "\nconstructor" + "\nGet timestamp field as DataViewField or return undefined" ], "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "children": [ + "() => ", { - "parentPluginId": "data", - "id": "def-common.DuplicateDataViewError.Unnamed.$1", - "type": "string", - "tags": [], - "label": "message", - "description": [ - "- Error message" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", - "deprecated": false, - "isRequired": true - } + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldType", - "type": "Class", - "tags": [], - "label": "KbnFieldType", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.KbnFieldType.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldType.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldType.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.KbnFieldType.esTypes", - "type": "Object", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "readonly ", - "ES_FIELD_TYPES", - "[]" - ], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldType.Unnamed", + "id": "def-server.DataView.getFieldByName", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "getFieldByName", + "description": [ + "\nGet field by name." + ], "signature": [ - "any" + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" ], - "path": "node_modules/@types/kbn__field-types/index.d.ts", + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.KbnFieldType.Unnamed.$1", - "type": "Object", + "id": "def-server.DataView.getFieldByName.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "signature": [ - "Partial<", - "KbnFieldTypeOptions", - "> | undefined" + "label": "name", + "description": [ + "field name" ], - "path": "node_modules/@types/kbn__field-types/index.d.ts", + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "data", - "id": "def-common.buildCustomFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildCustomFilter", - "description": [], - "signature": [ - "(indexPatternString: string, queryDsl: ", - "QueryDslQueryContainer", - ", disabled: boolean, negate: boolean, alias: string | null, store: ", - "FilterStateStore", - ") => ", - "Filter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$1", - "type": "string", - "tags": [], - "label": "indexPatternString", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$2", - "type": "Object", + "id": "def-server.DataView.getAggregationRestrictions", + "type": "Function", "tags": [], - "label": "queryDsl", - "description": [], + "label": "getAggregationRestrictions", + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], "signature": [ - "QueryDslQueryContainer" + "() => Record | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$3", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$5", - "type": "CompoundType", + "id": "def-server.DataView.getAsSavedObjectBody", + "type": "Function", "tags": [], - "label": "alias", - "description": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], "signature": [ - "string | null" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildCustomFilter.$6", - "type": "Enum", + "id": "def-server.DataView.getFormatterForField", + "type": "Function", "tags": [], - "label": "store", - "description": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], "signature": [ - "FilterStateStore" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildEmptyFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "(isPinned: boolean, index?: string | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildEmptyFilter.$1", - "type": "boolean", - "tags": [], - "label": "isPinned", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field to get formatter for" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildEmptyFilter.$2", - "type": "string", + "id": "def-server.DataView.addRuntimeField", + "type": "Function", "tags": [], - "label": "index", - "description": [], - "signature": [ - "string | undefined" + "label": "addRuntimeField", + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildEsQuery", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildEsQuery", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - " | undefined, queries: ", - "Query", - " | ", - "Query", - "[], filters: ", - "Filter", - " | ", - "Filter", - "[], config?: ", - "EsQueryConfig", - " | undefined) => { bool: ", - "BoolQuery", - "; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildEsQuery.$1", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], "signature": [ - "DataViewBase", - " | undefined" + "(name: string, runtimeField: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.addRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.addRuntimeField.$2", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "Runtime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildEsQuery.$2", - "type": "CompoundType", + "id": "def-server.DataView.hasRuntimeField", + "type": "Function", "tags": [], - "label": "queries", - "description": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" + ], "signature": [ - "Query", - " | ", - "Query", - "[]" + "(name: string) => boolean" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.hasRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildEsQuery.$3", - "type": "CompoundType", + "id": "def-server.DataView.getRuntimeField", + "type": "Function", "tags": [], - "label": "filters", - "description": [], + "label": "getRuntimeField", + "description": [ + "\nReturns runtime field if exists" + ], "signature": [ - "Filter", - " | ", - "Filter", - "[]" + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | null" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildEsQuery.$4", - "type": "CompoundType", + "id": "def-server.DataView.getAllRuntimeFields", + "type": "Function", "tags": [], - "label": "config", - "description": [], - "signature": [ - "EsQueryConfig", - " | undefined" + "label": "getAllRuntimeFields", + "description": [ + "\nGet all runtime field definitions." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildExistsFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildExistsFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", indexPattern: ", - "DataViewBase", - ") => ", - "ExistsFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildExistsFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + "() => Record" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] }, { "parentPluginId": "data", - "id": "def-common.buildExistsFilter.$2", - "type": "Object", + "id": "def-server.DataView.getFieldsByRuntimeFieldName", + "type": "Function", "tags": [], - "label": "indexPattern", - "description": [], + "label": "getFieldsByRuntimeFieldName", + "description": [ + "\nReturns data view fields backed by runtime fields." + ], "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" + "(name: string) => Record | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildFilter", - "description": [], - "signature": [ - "(indexPattern: ", - "DataViewBase", - ", field: ", - "DataViewFieldBase", - ", type: ", - "FILTERS", - ", negate: boolean, disabled: boolean, params: ", - "Serializable", - ", alias: string | null, store?: ", - "FilterStateStore", - " | undefined) => ", - "Filter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "map of DataViewFields (that are runtime fields) by field name" + ] + }, { "parentPluginId": "data", - "id": "def-common.buildFilter.$1", - "type": "Object", + "id": "def-server.DataView.replaceAllRuntimeFields", + "type": "Function", "tags": [], - "label": "indexPattern", - "description": [], + "label": "replaceAllRuntimeFields", + "description": [ + "\nReplaces all existing runtime fields with new fields." + ], "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" + "(newFields: Record) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.replaceAllRuntimeFields.$1", + "type": "Object", + "tags": [], + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildFilter.$2", - "type": "Object", + "id": "def-server.DataView.removeRuntimeField", + "type": "Function", "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + "label": "removeRuntimeField", + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildFilter.$3", - "type": "Enum", - "tags": [], - "label": "type", - "description": [], "signature": [ - "FILTERS" + "(name: string) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildFilter.$4", - "type": "boolean", - "tags": [], - "label": "negate", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildFilter.$5", - "type": "boolean", - "tags": [], - "label": "disabled", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildFilter.$6", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "string | number | boolean | ", - "SerializableRecord", - " | SerializableArray | null | undefined" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.removeRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "- Field name to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildFilter.$7", - "type": "CompoundType", + "id": "def-server.DataView.getRuntimeMappings", + "type": "Function", "tags": [], - "label": "alias", - "description": [], + "label": "getRuntimeMappings", + "description": [ + "\nReturn the \"runtime_mappings\" section of the ES search query." + ], "signature": [ - "string | null" + "() => ", + "MappingRuntimeFields" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildFilter.$8", - "type": "CompoundType", + "id": "def-server.DataView.getFormatterForFieldNoDefault", + "type": "Function", "tags": [], - "label": "store", - "description": [], + "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists." + ], "signature": [ - "FilterStateStore", + "(fieldname: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, " | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhraseFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildPhraseFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", value: PhraseFilterValue, indexPattern: ", - "DataViewBase", - ") => ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildPhraseFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", + "tags": [], + "label": "fieldname", + "description": [ + "name of field to get formatter for" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildPhraseFilter.$2", - "type": "CompoundType", + "id": "def-server.DataView.setFieldAttrs", + "type": "Function", "tags": [], - "label": "value", - "description": [], - "signature": [ - "string | number | boolean" + "label": "setFieldAttrs", + "description": [ + "\nSet field attribute" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhraseFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhrasesFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildPhrasesFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: PhraseFilterValue[], indexPattern: ", - "DataViewBase", - ") => ", - "PhrasesFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildPhrasesFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$2", + "type": "Uncategorized", + "tags": [], + "label": "attrName", + "description": [ + "name of attribute to set" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildPhrasesFilter.$2", - "type": "Array", + "id": "def-server.DataView.setFieldCustomLabel", + "type": "Function", "tags": [], - "label": "params", - "description": [], - "signature": [ - "PhraseFilterValue[]" + "label": "setFieldCustomLabel", + "description": [ + "\nSet field custom label" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhrasesFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], "signature": [ - "{ fields: ", - "DataViewFieldBase", - "[]; id?: string | undefined; title: string; }" + "(fieldName: string, customLabel: string | null | undefined) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildQueryFilter", - "description": [], - "signature": [ - "(query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined, index: string, alias?: string | undefined, meta?: ", - "FilterMeta", - " | undefined) => { query: (Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined; meta: { alias: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index: string; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildQueryFilter.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "(Record & { query_string?: { query: string; fields?: string[] | undefined; } | undefined; }) | undefined" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCustomLabel.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set custom label on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", + "tags": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFilter.$2", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildQueryFilter.$3", - "type": "string", + "id": "def-server.DataView.setFieldCount", + "type": "Function", "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | undefined" + "label": "setFieldCount", + "description": [ + "\nSet field count" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFilter.$4", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], "signature": [ - "FilterMeta", - " | undefined" + "(fieldName: string, count: number | null | undefined) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFromFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildQueryFromFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[] | undefined, indexPattern: ", - "DataViewBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => ", - "BoolQuery" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildQueryFromFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCount.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set count on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildQueryFromFilters.$2", - "type": "Object", + "id": "def-server.DataView.setFieldFormat", + "type": "Function", "tags": [], - "label": "indexPattern", - "description": [], - "signature": [ - "DataViewBase", - " | undefined" + "label": "setFieldFormat", + "description": [ + "\nSet field formatter" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFromFilters.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [], "signature": [ - "boolean | undefined" + "(fieldName: string, format: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + "SerializableRecord", + ">) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildRangeFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "buildRangeFilter", - "description": [], - "signature": [ - "(field: ", - "DataViewFieldBase", - ", params: ", - "RangeFilterParams", - ", indexPattern?: ", - "DataViewBase", - " | undefined, formattedValue?: string | undefined) => ", - "RangeFilter", - " | ", - "ScriptedRangeFilter", - " | MatchAllRangeFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.buildRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ name: string; type: string; subType?: ", - "IFieldSubType", - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + "SerializableRecord", + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.buildRangeFilter.$2", - "type": "Object", + "id": "def-server.DataView.deleteFieldFormat", + "type": "Function", "tags": [], - "label": "params", - "description": [], - "signature": [ - "RangeFilterParams" + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildRangeFilter.$3", - "type": "Object", - "tags": [], - "label": "indexPattern", - "description": [], "signature": [ - "DataViewBase", - " | undefined" + "(fieldName: string) => void" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildRangeFilter.$4", - "type": "string", - "tags": [], - "label": "formattedValue", - "description": [], - "signature": [ - "string | undefined" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataView.deleteFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.cellHasFormulas", - "type": "Function", + "id": "def-server.DataViewsService", + "type": "Class", "tags": [], - "label": "cellHasFormulas", - "description": [], - "signature": [ - "(val: string) => boolean" + "label": "DataViewsService", + "description": [ + "\nData views service, providing CRUD operations for data views." ], - "path": "src/plugins/data/common/exports/formula_checks.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.cellHasFormulas.$1", - "type": "string", + "id": "def-server.DataViewsService.getCanSave", + "type": "Function", "tags": [], - "label": "val", - "description": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], "signature": [ - "string" + "() => Promise" ], - "path": "src/plugins/data/common/exports/formula_checks.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.compareFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "compareFilters", - "description": [], - "signature": [ - "(first: ", - "Filter", - " | ", - "Filter", - "[], second: ", - "Filter", - " | ", - "Filter", - "[], comparatorOptions?: ", - "FilterCompareOptions", - " | undefined) => boolean" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "returnComment": [], + "children": [] + }, { "parentPluginId": "data", - "id": "def-common.compareFilters.$1", - "type": "CompoundType", + "id": "def-server.DataViewsService.Unnamed", + "type": "Function", "tags": [], - "label": "first", - "description": [], + "label": "Constructor", + "description": [ + "\nDataViewsService constructor" + ], "signature": [ - "Filter", - " | ", - "Filter", - "[]" + "any" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.compareFilters.$2", - "type": "CompoundType", + "id": "def-server.DataViewsService.getIds", + "type": "Function", "tags": [], - "label": "second", - "description": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], "signature": [ - "Filter", - " | ", - "Filter", - "[]" + "(refresh?: boolean) => Promise" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIds.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.compareFilters.$3", - "type": "Object", + "id": "def-server.DataViewsService.getTitles", + "type": "Function", "tags": [], - "label": "comparatorOptions", - "description": [], - "signature": [ - "FilterCompareOptions", - " | undefined" + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.createEscapeValue", - "type": "Function", - "tags": [], - "label": "createEscapeValue", - "description": [ - "\nCreate a function that will escape CSV values like \"=\", \"@\" and \"+\" with a\n\"'\". This will also place CSV values in \"\" if contain non-alphanumeric chars.\n\nFor example:\n\nGiven: =1+1\nReturns: \"'=1+1\"\n\nSee OWASP: https://www.owasp.org/index.php/CSV_Injection." - ], - "signature": [ - "(quoteValues: boolean, escapeFormulas: boolean) => (val: RawValue) => string" - ], - "path": "src/plugins/data/common/exports/escape_value.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.createEscapeValue.$1", - "type": "boolean", - "tags": [], - "label": "quoteValues", - "description": [], "signature": [ - "boolean" + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getTitles.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data/common/exports/escape_value.ts", - "deprecated": false, - "isRequired": true + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.createEscapeValue.$2", - "type": "boolean", + "id": "def-server.DataViewsService.find", + "type": "Function", "tags": [], - "label": "escapeFormulas", - "description": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], "signature": [ - "boolean" + "(search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" ], - "path": "src/plugins/data/common/exports/escape_value.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.datatableToCSV", - "type": "Function", - "tags": [], - "label": "datatableToCSV", - "description": [], - "signature": [ - "({ columns, rows }: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "Number of data views to return" + ], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView[]" + ] }, - ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.datatableToCSV.$1", - "type": "Object", + "id": "def-server.DataViewsService.getIdsWithTitle", + "type": "Function", "tags": [], - "label": "{ columns, rows }", - "description": [], + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." + ], "signature": [ + "(refresh?: boolean) => Promise<", { - "pluginId": "expressions", + "pluginId": "dataViews", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" ], - "path": "src/plugins/data/common/exports/export_csv.tsx", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getIdsWithTitle.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.datatableToCSV.$2", - "type": "Object", + "id": "def-server.DataViewsService.clearCache", + "type": "Function", "tags": [], - "label": "{ csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }", - "description": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache." + ], "signature": [ - "CSVOptions" + "(id?: string | undefined) => void" ], - "path": "src/plugins/data/common/exports/export_csv.tsx", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.decorateQuery", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "decorateQuery", - "description": [], - "signature": [ - "(query: ", - "QueryDslQueryContainer", - ", queryStringOptions: string | ", - "SerializableRecord", - ", dateFormatTZ?: string | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.decorateQuery.$1", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "QueryDslQueryContainer" + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.decorateQuery.$2", - "type": "CompoundType", + "id": "def-server.DataViewsService.getCache", + "type": "Function", "tags": [], - "label": "queryStringOptions", - "description": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], "signature": [ - "string | ", - "SerializableRecord" + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.decorateQuery.$3", - "type": "string", + "id": "def-server.DataViewsService.getDefault", + "type": "Function", "tags": [], - "label": "dateFormatTZ", - "description": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], "signature": [ - "string | undefined" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.dedupFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "dedupFilters", - "description": [], - "signature": [ - "(existingFilters: ", - "Filter", - "[], filters: ", - "Filter", - "[], comparatorOptions?: ", - "FilterCompareOptions", - " | undefined) => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.dedupFilters.$1", - "type": "Array", + "id": "def-server.DataViewsService.getDefaultId", + "type": "Function", "tags": [], - "label": "existingFilters", - "description": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" + ], "signature": [ - "Filter", - "[]" + "() => Promise" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.dedupFilters.$2", - "type": "Array", + "id": "def-server.DataViewsService.setDefault", + "type": "Function", "tags": [], - "label": "filters", - "description": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], "signature": [ - "Filter", - "[]" + "(id: string | null, force?: boolean) => Promise" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "data view id" + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.dedupFilters.$3", - "type": "Object", + "id": "def-server.DataViewsService.hasUserDataView", + "type": "Function", "tags": [], - "label": "comparatorOptions", - "description": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], "signature": [ - "FilterCompareOptions", - " | undefined" + "() => Promise" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.disableFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "disableFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => ", - "Filter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.disableFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.getFieldsForWildcard", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.enableFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "enableFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => ", - "Filter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "FieldSpec[]" + ] + }, { "parentPluginId": "data", - "id": "def-common.enableFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.getFieldsForIndexPattern", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$1", + "type": "CompoundType", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.getFieldsForIndexPattern.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.fieldList", - "type": "Function", - "tags": [], - "label": "fieldList", - "description": [], - "signature": [ - "(specs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "returnComment": [ + "FieldSpec[]" + ] }, - "[], shortDotsEnable?: boolean) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.fieldList.$1", - "type": "Array", + "id": "def-server.DataViewsService.refreshFields", + "type": "Function", "tags": [], - "label": "specs", - "description": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern." + ], "signature": [ + "(indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataView", + "text": "DataView" }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.fieldList.$2", - "type": "boolean", - "tags": [], - "label": "shortDotsEnable", - "description": [], - "signature": [ - "boolean" + ") => Promise" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.fromKueryExpression", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "fromKueryExpression", - "description": [], - "signature": [ - "(expression: string | ", - "QueryDslQueryContainer", - ", parseOptions?: Partial<", - "KueryParseOptions", - "> | undefined) => ", - "KueryNode" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.fromKueryExpression.$1", - "type": "CompoundType", - "tags": [], - "label": "expression", - "description": [], - "signature": [ - "string | ", - "QueryDslQueryContainer" + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.fromKueryExpression.$2", - "type": "Object", + "id": "def-server.DataViewsService.fieldArrayToMap", + "type": "Function", "tags": [], - "label": "parseOptions", - "description": [], - "signature": [ - "Partial<", - "KueryParseOptions", - "> | undefined" + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getEsQueryConfig", - "type": "Function", - "tags": [], - "label": "getEsQueryConfig", - "description": [], - "signature": [ - "(config: KibanaConfig) => ", - "EsQueryConfig" - ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getEsQueryConfig.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], "signature": [ - "KibanaConfig" + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } ], - "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeMulti", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getFieldSubtypeMulti.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - "IFieldSubTypeNested", - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ + "returnComment": [ + "Record" + ] + }, { "parentPluginId": "data", - "id": "def-common.getFieldSubtypeNested.$1", - "type": "Object", + "id": "def-server.DataViewsService.savedObjectToSpec", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." + ], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getIndexPatternLoadMeta", - "type": "Function", - "tags": [], - "label": "getIndexPatternLoadMeta", - "description": [], - "signature": [ - "() => Omit<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", - "text": "IndexPatternLoadExpressionFunctionDefinition" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataViewSpec" + ] }, - ", \"fn\">" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getPhraseFilterField", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getPhraseFilterField", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - ") => string" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ { "parentPluginId": "data", - "id": "def-common.getPhraseFilterField.$1", - "type": "CompoundType", + "id": "def-server.DataViewsService.get", + "type": "Function", "tags": [], - "label": "filter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getPhraseFilterValue", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "getPhraseFilterValue", - "description": [], - "signature": [ - "(filter: ", - "PhraseFilter", - " | ", - "ScriptedPhraseFilter", - ") => PhraseFilterValue" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getPhraseFilterValue.$1", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], "signature": [ - "PhraseFilter", - " | ", - "ScriptedPhraseFilter" + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isExistsFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isExistsFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "ExistsFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isExistsFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.create", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.create.$2", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isFilterable", - "type": "Function", - "tags": [], - "label": "isFilterable", - "description": [], - "signature": [ - "(field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "returnComment": [ + "DataView" + ] }, - ") => boolean" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-common.isFilterable.$1", - "type": "Object", + "id": "def-server.DataViewsService.createAndSave", + "type": "Function", "tags": [], - "label": "field", - "description": [], + "label": "createAndSave", + "description": [ + "\nCreate a new data view and save it right away." + ], "signature": [ + "(spec: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" ], - "path": "src/plugins/data_views/common/fields/utils.ts", + "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isFilterDisabled", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isFilterDisabled", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => boolean" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.isFilterDisabled.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createAndSave.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createAndSave.$3", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isFilterPinned", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isFilterPinned", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => boolean | undefined" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isFilterPinned.$1", - "type": "Object", + "id": "def-server.DataViewsService.createSavedObject", + "type": "Function", "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "label": "createSavedObject", + "description": [ + "\nSave a new data view." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isFilters", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isFilters", - "description": [], - "signature": [ - "(x: unknown) => x is ", - "Filter", - "[]" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.isFilters.$1", - "type": "Unknown", - "tags": [], - "label": "x", - "description": [], "signature": [ - "unknown" + "(dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "data view instance" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.createSavedObject.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isMatchAllFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isMatchAllFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "MatchAllFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isMatchAllFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.updateSavedObject", + "type": "Function", "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isMultiField", - "type": "Function", - "tags": [], - "label": "isMultiField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.isMultiField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isNestedField", - "type": "Function", - "tags": [], - "label": "isNestedField", - "description": [], - "signature": [ - "(field: HasSubtype) => boolean" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.isNestedField.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - "IFieldSubType", - " | undefined; }" + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.updateSavedObject.$3", + "type": "boolean", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isPhraseFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isPhraseFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhraseFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isPhraseFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.delete", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "(indexPatternId: string) => Promise<{}>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isPhrasesFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isPhrasesFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "PhrasesFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsService.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isPhrasesFilter.$1", - "type": "Object", + "id": "def-server.DataViewsService.getDefaultDataView", + "type": "Function", "tags": [], - "label": "filter", - "description": [], + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.isQueryStringFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isQueryStringFilter", + "id": "def-server.IndexPatternsFetcher", + "type": "Class", + "tags": [], + "label": "IndexPatternsFetcher", "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => filter is ", - "QueryStringFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.isQueryStringFilter.$1", - "type": "Object", + "id": "def-server.IndexPatternsFetcher.Unnamed", + "type": "Function", "tags": [], - "label": "filter", + "label": "Constructor", "description": [], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "any" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isRangeFilter", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "isRangeFilter", - "description": [], - "signature": [ - "(filter?: ", - "Filter", - " | undefined) => filter is ", - "RangeFilter" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "elasticsearchClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.Unnamed.$2", + "type": "boolean", + "tags": [], + "label": "allowNoIndices", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.isRangeFilter.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard", + "type": "Function", + "tags": [ + "property", + "property", + "return" + ], + "label": "getFieldsForWildcard", + "description": [ + "\n Get a list of field objects for an index pattern that may contain wildcards\n" + ], "signature": [ - "Filter", - " | undefined" + "(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; filter?: ", + "QueryDslQueryContainer", + " | undefined; }) => Promise<", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]>" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.luceneStringToDsl", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "luceneStringToDsl", - "description": [], - "signature": [ - "(query: string | ", - "QueryDslQueryContainer", - ") => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.pattern", + "type": "CompoundType", + "tags": [], + "label": "pattern", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.fieldCapsOptions", + "type": "Object", + "tags": [], + "label": "fieldCapsOptions", + "description": [], + "signature": [ + "{ allow_no_indices: boolean; } | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.rollupIndex", + "type": "string", + "tags": [], + "label": "rollupIndex", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.luceneStringToDsl.$1", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], + "id": "def-server.IndexPatternsFetcher.validatePatternListActive", + "type": "Function", + "tags": [ + "return" + ], + "label": "validatePatternListActive", + "description": [ + "\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n" + ], "signature": [ - "string | ", - "QueryDslQueryContainer" + "(patternList: string[]) => Promise" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1", + "type": "Array", + "tags": [], + "label": "patternList", + "description": [ + "string[]" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "data", - "id": "def-common.onlyDisabledFiltersChanged", + "id": "def-server.getCapabilitiesForRollupIndices", "type": "Function", - "tags": [ - "deprecated" + "tags": [], + "label": "getCapabilitiesForRollupIndices", + "description": [ + "\nGet rollup job capabilities" ], - "label": "onlyDisabledFiltersChanged", - "description": [], "signature": [ - "(newFilters?: ", - "Filter", - "[] | undefined, oldFilters?: ", - "Filter", - "[] | undefined) => boolean" + "(indices: Record) => { [key: string]: any; }" ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.onlyDisabledFiltersChanged.$1", - "type": "Array", + "id": "def-server.getCapabilitiesForRollupIndices.$1", + "type": "Object", "tags": [], - "label": "newFilters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" + "label": "indices", + "description": [ + "rollup job index capabilites" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.onlyDisabledFiltersChanged.$2", - "type": "Array", - "tags": [], - "label": "oldFilters", - "description": [], "signature": [ - "Filter", - "[] | undefined" + "Record" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data_views/server/fetcher/lib/map_capabilities.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.pinFilter", + "id": "def-server.getEsQueryConfig", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "pinFilter", + "tags": [], + "label": "getEsQueryConfig", "description": [], "signature": [ - "(filter: ", - "Filter", - ") => ", - "Filter" + "(config: KibanaConfig) => ", + "EsQueryConfig" ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.pinFilter.$1", + "id": "def-server.getEsQueryConfig.$1", "type": "Object", "tags": [], - "label": "filter", + "label": "config", "description": [], "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" + "KibanaConfig" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.tableHasFormulas", + "id": "def-server.getRequestAbortedSignal", "type": "Function", "tags": [], - "label": "tableHasFormulas", - "description": [], + "label": "getRequestAbortedSignal", + "description": [ + "\nA simple utility function that returns an `AbortSignal` corresponding to an `AbortController`\nwhich aborts when the given request is aborted." + ], "signature": [ - "(columns: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[], rows: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]) => boolean" + "(aborted$: ", + "Observable", + ") => AbortSignal" ], - "path": "src/plugins/data/common/exports/formula_checks.ts", + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.tableHasFormulas.$1", - "type": "Array", + "id": "def-server.getRequestAbortedSignal.$1", + "type": "Object", "tags": [], - "label": "columns", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[]" + "label": "aborted$", + "description": [ + "The observable of abort events (usually `request.events.aborted$`)" ], - "path": "src/plugins/data/common/exports/formula_checks.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-common.tableHasFormulas.$2", - "type": "Array", - "tags": [], - "label": "rows", - "description": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableRow", - "text": "DatatableRow" - }, - "[]" + "Observable", + "" ], - "path": "src/plugins/data/common/exports/formula_checks.ts", + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", "deprecated": false, "isRequired": true } @@ -28400,500 +14497,1874 @@ }, { "parentPluginId": "data", - "id": "def-common.toElasticsearchQuery", + "id": "def-server.getTime", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "toElasticsearchQuery", + "tags": [], + "label": "getTime", "description": [], "signature": [ - "(node: ", - "KueryNode", - ", indexPattern?: ", - "DataViewBase", - " | undefined, config?: ", - "KueryQueryOptions", - " | undefined, context?: Record | undefined) => ", - "QueryDslQueryContainer" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ + "(indexPattern: ", { - "parentPluginId": "data", - "id": "def-common.toElasticsearchQuery.$1", - "type": "Object", - "tags": [], - "label": "node", - "description": [], - "signature": [ - "KueryNode" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " | undefined, timeRange: ", + "TimeRange", + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.toElasticsearchQuery.$2", + "id": "def-server.getTime.$1", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ - "DataViewBase", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, " | undefined" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": false }, { "parentPluginId": "data", - "id": "def-common.toElasticsearchQuery.$3", + "id": "def-server.getTime.$2", "type": "Object", "tags": [], - "label": "config", + "label": "timeRange", "description": [], "signature": [ - "KueryQueryOptions", - " | undefined" + "TimeRange" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.toElasticsearchQuery.$4", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.toggleFilterDisabled", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "toggleFilterDisabled", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => { meta: { disabled: boolean; alias?: string | null | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", - "FilterStateStore", - "; } | undefined; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.toggleFilterDisabled.$1", - "type": "Object", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.toggleFilterNegated", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "toggleFilterNegated", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ") => { meta: { negate: boolean; alias?: string | null | undefined; disabled?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", - "FilterStateStore", - "; } | undefined; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.toggleFilterNegated.$1", + "id": "def-server.getTime.$3", "type": "Object", "tags": [], - "label": "filter", + "label": "options", "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.getTime.$3.forceNow", + "type": "Object", + "tags": [], + "label": "forceNow", + "description": [], + "signature": [ + "Date | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.getTime.$3.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "deprecated": false + } + ] } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.uniqFilters", + "id": "def-server.parseInterval", "type": "Function", - "tags": [ - "deprecated" - ], - "label": "uniqFilters", + "tags": [], + "label": "parseInterval", "description": [], "signature": [ - "(filters: ", - "Filter", - "[], comparatorOptions?: ", - "FilterCompareOptions", - " | undefined) => ", - "Filter", - "[]" + "(interval: string) => moment.Duration | null" ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "returnComment": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.uniqFilters.$1", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[]" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.uniqFilters.$2", - "type": "Object", + "id": "def-server.parseInterval.$1", + "type": "string", "tags": [], - "label": "comparatorOptions", + "label": "interval", "description": [], "signature": [ - "FilterCompareOptions", - " | undefined" + "string" ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "data", - "id": "def-common.DataViewAttributes", + "id": "def-server.DataViewsServerPluginStart", "type": "Interface", "tags": [], - "label": "DataViewAttributes", + "label": "DataViewsServerPluginStart", "description": [ - "\nInterface for the data view saved object" + "\nDataViews server plugin start api" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewAttributes.fields", - "type": "string", - "tags": [], - "label": "fields", - "description": [ - "\nFields as a serialized array of field specs" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.title", - "type": "string", - "tags": [], - "label": "title", - "description": [ - "\nData view title" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nData view type, default or rollup" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.typeMeta", - "type": "string", - "tags": [], - "label": "typeMeta", - "description": [ - "\nType metadata information, serialized. Only used by rollup data views." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.timeFieldName", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [ - "\nTime field name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.sourceFilters", - "type": "string", - "tags": [], - "label": "sourceFilters", - "description": [ - "\nSerialized array of filters. Used by discover to hide fields." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.fieldFormatMap", - "type": "string", - "tags": [], - "label": "fieldFormatMap", - "description": [ - "\nSerialized map of field formats by field name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.fieldAttrs", - "type": "string", - "tags": [], - "label": "fieldAttrs", - "description": [ - "\nSerialized map of field attributes, currently field count and name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.runtimeFieldMap", - "type": "string", - "tags": [], - "label": "runtimeFieldMap", - "description": [ - "\nSerialized map of runtime field definitions, by field name" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.allowNoIndex", - "type": "CompoundType", - "tags": [], - "label": "allowNoIndex", - "description": [ - "\nPrevents errors when index pattern exists before indices" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewAttributes.name", - "type": "string", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory", + "type": "Function", "tags": [], - "label": "name", + "label": "dataViewsServiceFactory", "description": [ - "\nName of the data view. Human readable name used to differentiate data view." + "\nReturns a DataViews service instance" ], "signature": [ - "string | undefined" + "(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", elasticsearchClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsService", + "text": "DataViewsService" + }, + ">" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$1", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$2", + "type": "Object", + "tags": [], + "label": "elasticsearchClient", + "description": [], + "signature": [ + "{ eql: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; monitoring: ", + "default", + "; security: ", + "default", + "; name: string | symbol; index: { (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; delete: { (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; get: { (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetResponse", + ">; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetResponse", + ", unknown>>; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetResponse", + ">; }; update: { (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateResponse", + ">; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateResponse", + ", unknown>>; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateResponse", + ">; }; closePointInTime: { (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClosePointInTimeResponse", + ", unknown>>; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "default", + "; helpers: ", + "default", + "; child: (opts: ", + "ClientOptions", + ") => ", + "default", + "; Internal: ", + "default", + "; asyncSearch: ", + "default", + "; autoscaling: ", + "default", + "; bulk: { (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "BulkResponse", + ">; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "BulkResponse", + ", unknown>>; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "BulkResponse", + ">; }; cat: ", + "default", + "; ccr: ", + "default", + "; clearScroll: { (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClearScrollResponse", + ">; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClearScrollResponse", + ", unknown>>; (this: That, params?: ", + "ClearScrollRequest", + " | ", + "ClearScrollRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClearScrollResponse", + ">; }; cluster: ", + "default", + "; count: { (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "CountResponse", + ">; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "CountResponse", + ", unknown>>; (this: That, params?: ", + "CountRequest", + " | ", + "CountRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "CountResponse", + ">; }; danglingIndices: ", + "default", + "; deleteByQuery: { (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "DeleteByQueryResponse", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRequest", + " | ", + "DeleteByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "DeleteByQueryResponse", + ">; }; deleteByQueryRethrottle: { (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TasksTaskListResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteByQueryRethrottleRequest", + " | ", + "DeleteByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TasksTaskListResponseBase", + ">; }; deleteScript: { (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteScriptRequest", + " | ", + "DeleteScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; enrich: ", + "default", + "; exists: { (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsRequest", + " | ", + "ExistsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; existsSource: { (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "ExistsSourceRequest", + " | ", + "ExistsSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; explain: { (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ExplainResponse", + ">; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ExplainResponse", + ", unknown>>; (this: That, params: ", + "ExplainRequest", + " | ", + "ExplainRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ExplainResponse", + ">; }; features: ", + "default", + "; fieldCaps: { (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "FieldCapsResponse", + ">; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "FieldCapsResponse", + ", unknown>>; (this: That, params: ", + "FieldCapsRequest", + " | ", + "FieldCapsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "FieldCapsResponse", + ">; }; fleet: ", + "default", + "; getScript: { (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptResponse", + ">; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptResponse", + ", unknown>>; (this: That, params: ", + "GetScriptRequest", + " | ", + "GetScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptResponse", + ">; }; getScriptContext: { (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptContextResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptContextRequest", + " | ", + "GetScriptContextRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptContextResponse", + ">; }; getScriptLanguages: { (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetScriptLanguagesResponse", + ", unknown>>; (this: That, params?: ", + "GetScriptLanguagesRequest", + " | ", + "GetScriptLanguagesRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetScriptLanguagesResponse", + ">; }; getSource: { (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "GetSourceRequest", + " | ", + "GetSourceRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; graph: ", + "default", + "; ilm: ", + "default", + "; indices: ", + "default", + "; info: { (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "InfoResponse", + ">; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "InfoResponse", + ", unknown>>; (this: That, params?: ", + "InfoRequest", + " | ", + "InfoRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "InfoResponse", + ">; }; ingest: ", + "default", + "; knnSearch: { (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "KnnSearchResponse", + ">; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "KnnSearchResponse", + ", unknown>>; (this: That, params: ", + "KnnSearchRequest", + " | ", + "KnnSearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "KnnSearchResponse", + ">; }; license: ", + "default", + "; logstash: ", + "default", + "; mget: { (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MgetResponse", + ">; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MgetResponse", + ", unknown>>; (this: That, params?: ", + "MgetRequest", + " | ", + "MgetRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MgetResponse", + ">; }; migration: ", + "default", + "; ml: ", + "default", + "; msearch: { >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchResponse", + ">; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchResponse", + ", unknown>>; >(this: That, params: ", + "MsearchRequest", + " | ", + "MsearchRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchResponse", + ">; }; msearchTemplate: { >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MsearchTemplateResponse", + ", unknown>>; >(this: That, params: ", + "MsearchTemplateRequest", + " | ", + "MsearchTemplateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MsearchTemplateResponse", + ">; }; mtermvectors: { (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "MtermvectorsResponse", + ", unknown>>; (this: That, params?: ", + "MtermvectorsRequest", + " | ", + "MtermvectorsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "MtermvectorsResponse", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "OpenPointInTimeResponse", + ", unknown>>; (this: That, params: ", + "OpenPointInTimeRequest", + " | ", + "OpenPointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "OpenPointInTimeResponse", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "AcknowledgedResponseBase", + ", unknown>>; (this: That, params: ", + "PutScriptRequest", + " | ", + "PutScriptRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "AcknowledgedResponseBase", + ">; }; rankEval: { (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RankEvalResponse", + ">; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RankEvalResponse", + ", unknown>>; (this: That, params: ", + "RankEvalRequest", + " | ", + "RankEvalRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RankEvalResponse", + ">; }; reindex: { (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexResponse", + ">; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexResponse", + ", unknown>>; (this: That, params: ", + "ReindexRequest", + " | ", + "ReindexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexResponse", + ">; }; reindexRethrottle: { (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ReindexRethrottleResponse", + ", unknown>>; (this: That, params: ", + "ReindexRethrottleRequest", + " | ", + "ReindexRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ReindexRethrottleResponse", + ">; }; renderSearchTemplate: { (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "RenderSearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "RenderSearchTemplateRequest", + " | ", + "RenderSearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "RenderSearchTemplateResponse", + ">; }; rollup: ", + "default", + "; scriptsPainlessExecute: { (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScriptsPainlessExecuteResponse", + ", unknown>>; (this: That, params?: ", + "ScriptsPainlessExecuteRequest", + " | ", + "ScriptsPainlessExecuteRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScriptsPainlessExecuteResponse", + ">; }; scroll: { >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ScrollResponse", + ">; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ScrollResponse", + ", unknown>>; >(this: That, params: ", + "ScrollRequest", + " | ", + "ScrollRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ScrollResponse", + ">; }; searchMvt: { (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params: ", + "SearchMvtRequest", + " | ", + "SearchMvtRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; searchShards: { (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchShardsResponse", + ">; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchShardsResponse", + ", unknown>>; (this: That, params?: ", + "SearchShardsRequest", + " | ", + "SearchShardsRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchShardsResponse", + ">; }; searchTemplate: { (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchTemplateResponse", + ", unknown>>; (this: That, params?: ", + "SearchTemplateRequest", + " | ", + "SearchTemplateRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchTemplateResponse", + ">; }; searchableSnapshots: ", + "default", + "; shutdown: ", + "default", + "; slm: ", + "default", + "; snapshot: ", + "default", + "; sql: ", + "default", + "; ssl: ", + "default", + "; tasks: ", + "default", + "; termsEnum: { (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermsEnumResponse", + ">; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermsEnumResponse", + ", unknown>>; (this: That, params: ", + "TermsEnumRequest", + " | ", + "TermsEnumRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermsEnumResponse", + ">; }; termvectors: { (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "TermvectorsResponse", + ">; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "TermvectorsResponse", + ", unknown>>; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermvectorsResponse", + ">; }; textStructure: ", + "default", + "; transform: ", + "default", + "; updateByQuery: { (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; }; updateByQueryRethrottle: { (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$3", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataViewsServerPluginStart.dataViewsServiceFactory.$4", + "type": "CompoundType", + "tags": [], + "label": "byPassCapabilities", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem", + "id": "def-server.FieldDescriptor", "type": "Interface", "tags": [], - "label": "DataViewListItem", - "description": [ - "\nResult from data view search - summary data." - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "FieldDescriptor", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.DataViewListItem.id", + "id": "def-server.FieldDescriptor.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.name", "type": "string", "tags": [], - "label": "id", - "description": [ - "\nSaved object id" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "name", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem.namespaces", - "type": "Array", + "id": "def-server.FieldDescriptor.readFromDocValues", + "type": "boolean", "tags": [], - "label": "namespaces", - "description": [ - "\nNamespace ids" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "readFromDocValues", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem.title", - "type": "string", + "id": "def-server.FieldDescriptor.searchable", + "type": "boolean", "tags": [], - "label": "title", - "description": [ - "\nData view title" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "label": "searchable", + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem.type", + "id": "def-server.FieldDescriptor.type", "type": "string", "tags": [], "label": "type", - "description": [ - "\nData view type" - ], + "description": [], + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.FieldDescriptor.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], "signature": [ - "string | undefined" + "string[]" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem.typeMeta", + "id": "def-server.FieldDescriptor.subType", "type": "Object", "tags": [], - "label": "typeMeta", - "description": [ - "\nData view type meta" - ], + "label": "subType", + "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined" + "FieldSubType | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.DataViewListItem.name", - "type": "string", + "id": "def-server.FieldDescriptor.metadata_field", + "type": "CompoundType", "tags": [], - "label": "name", + "label": "metadata_field", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", + "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "deprecated": false } ], @@ -28901,619 +16372,1022 @@ }, { "parentPluginId": "data", - "id": "def-common.FilterValueFormatter", + "id": "def-server.IEsSearchRequest", "type": "Interface", "tags": [], - "label": "FilterValueFormatter", + "label": "IEsSearchRequest", "description": [], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.convert", - "type": "Function", - "tags": [], - "label": "convert", - "description": [], - "signature": [ - "(value: any) => string" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.convert.$1", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false - } - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" }, + ">" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.getConverterFor", - "type": "Function", + "id": "def-server.IEsSearchRequest.indexType", + "type": "string", "tags": [], - "label": "getConverterFor", + "label": "indexType", "description": [], "signature": [ - "(type: string) => FilterFormatterFunction" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.getConverterFor.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [] + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions", + "id": "def-server.ISearchOptions", "type": "Interface", "tags": [], - "label": "GetFieldsOptions", + "label": "ISearchOptions", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.pattern", - "type": "string", + "id": "def-server.ISearchOptions.abortSignal", + "type": "Object", + "tags": [], + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "signature": [ + "AbortSignal | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.strategy", + "type": "string", + "tags": [], + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", "tags": [], - "label": "pattern", - "description": [], - "path": "src/plugins/data_views/common/types.ts", + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.type", + "id": "def-server.ISearchOptions.sessionId", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], "signature": [ "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.lookBack", + "id": "def-server.ISearchOptions.isStored", "type": "CompoundType", "tags": [], - "label": "lookBack", - "description": [], + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], "signature": [ "boolean | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.metaFields", - "type": "Array", + "id": "def-server.ISearchOptions.isRestore", + "type": "CompoundType", "tags": [], - "label": "metaFields", - "description": [], + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], "signature": [ - "string[] | undefined" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.rollupIndex", - "type": "string", + "id": "def-server.ISearchOptions.indexPattern", + "type": "Object", "tags": [], - "label": "rollupIndex", - "description": [], + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], "signature": [ - "string | undefined" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.allowNoIndex", - "type": "CompoundType", + "id": "def-server.ISearchOptions.inspector", + "type": "Object", "tags": [], - "label": "allowNoIndex", - "description": [], + "label": "inspector", + "description": [ + "\nInspector integration options" + ], "signature": [ - "boolean | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IInspectorInfo", + "text": "IInspectorInfo" + }, + " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.GetFieldsOptions.filter", + "id": "def-server.ISearchOptions.executionContext", "type": "Object", "tags": [], - "label": "filter", + "label": "executionContext", "description": [], "signature": [ - "QueryDslQueryContainer", + "KibanaExecutionContext", " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "data", + "id": "def-server.ES_FIELD_TYPES", + "type": "Enum", + "tags": [], + "label": "ES_FIELD_TYPES", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient", - "type": "Interface", + "id": "def-server.KBN_FIELD_TYPES", + "type": "Enum", "tags": [], - "label": "IDataViewsApiClient", + "label": "KBN_FIELD_TYPES", "description": [], - "path": "src/plugins/data_views/common/types.ts", + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.METRIC_TYPES", + "type": "Enum", + "tags": [], + "label": "METRIC_TYPES", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "data", + "id": "def-server.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "tags": [], + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "signature": [ + "\"kuery\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.ES_SEARCH_STRATEGY", + "type": "string", + "tags": [], + "label": "ES_SEARCH_STRATEGY", + "description": [], + "signature": [ + "\"es\"" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.IEsSearchResponse", + "type": "Type", + "tags": [], + "label": "IEsSearchResponse", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + "<", + "SearchResponse", + ">>" + ], + "path": "src/plugins/data/common/search/strategies/es_search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.ParsedInterval", + "type": "Type", + "tags": [], + "label": "ParsedInterval", + "description": [], + "signature": [ + "{ value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" + ], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "data", + "id": "def-server.exporters", + "type": "Object", + "tags": [], + "label": "exporters", + "description": [], + "path": "src/plugins/data/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", + "id": "def-server.exporters.datatableToCSV", "type": "Function", "tags": [], - "label": "getFieldsForWildcard", + "label": "datatableToCSV", "description": [], "signature": [ - "(options: ", + "({ columns, rows }: ", { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" }, - ") => Promise" + ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/server/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", + "id": "def-server.exporters.datatableToCSV.$1", "type": "Object", "tags": [], - "label": "options", + "label": "__0", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.exporters.datatableToCSV.$2", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "CSVOptions" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false } - ], - "returnComment": [] + ] }, { "parentPluginId": "data", - "id": "def-common.IDataViewsApiClient.hasUserIndexPattern", - "type": "Function", + "id": "def-server.exporters.CSV_MIME_TYPE", + "type": "string", "tags": [], - "label": "hasUserIndexPattern", + "label": "CSV_MIME_TYPE", "description": [], - "signature": [ - "() => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/plugins/data/server/index.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType", - "type": "Interface", + "id": "def-server.search", + "type": "Object", "tags": [], - "label": "IndexPatternExpressionType", - "description": [ - "\nIndex pattern expression interface" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "label": "search", + "description": [], + "path": "src/plugins/data/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nExpression type" - ], - "signature": [ - "\"index_pattern\"" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternExpressionType.value", + "id": "def-server.search.aggs", "type": "Object", "tags": [], - "label": "value", - "description": [ - "\nValue - DataViewSpec" - ], - "signature": [ - "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined; fields?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - " | undefined; typeMeta?: ", + "label": "aggs", + "description": [], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "parentPluginId": "data", + "id": "def-server.search.aggs.CidrMask", + "type": "Object", + "tags": [], + "label": "CidrMask", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMask", + "text": "CidrMask" + } + ], + "path": "src/plugins/data/server/index.ts", + "deprecated": false }, - " | undefined; type?: string | undefined; fieldFormats?: Record Interval" + ], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.dateHistogramInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "deprecated": false + } + ] }, - "<", - "SerializableRecord", - ">> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions", - "type": "Interface", - "tags": [], - "label": "KbnFieldTypeOptions", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.sortable", - "type": "boolean", - "tags": [], - "label": "sortable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.filterable", - "type": "boolean", - "tags": [], - "label": "filterable", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.KbnFieldTypeOptions.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "ES_FIELD_TYPES", - "[]" - ], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false + "parentPluginId": "data", + "id": "def-server.search.aggs.parseInterval", + "type": "Function", + "tags": [], + "label": "parseInterval", + "description": [], + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.parseInterval.$1", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-server.search.aggs.calcAutoIntervalLessThan", + "type": "Function", + "tags": [], + "label": "calcAutoIntervalLessThan", + "description": [], + "signature": [ + "(maxBucketCount: number, duration: number) => moment.Duration" + ], + "path": "src/plugins/data/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.search.aggs.calcAutoIntervalLessThan.$1", + "type": "number", + "tags": [], + "label": "maxBucketCount", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.search.aggs.calcAutoIntervalLessThan.$2", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "deprecated": false + } + ] + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.SavedObject", - "type": "Interface", + "id": "def-server.UI_SETTINGS", + "type": "Object", "tags": [], - "label": "SavedObject", + "label": "UI_SETTINGS", "description": [], "signature": [ - "SavedObject", - "" + "{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; readonly AUTOCOMPLETE_VALUE_SUGGESTION_METHOD: \"autocomplete:valueSuggestionMethod\"; readonly DATE_FORMAT: \"dateFormat\"; readonly DATEFORMAT_TZ: \"dateFormat:tz\"; }" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/plugins/data/common/constants.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, + "initialIsOpen": false + } + ], + "setup": { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup", + "type": "Interface", + "tags": [], + "label": "DataPluginSetup", + "description": [], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "ISearchSetup" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "QuerySetup" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginSetup.fieldFormats", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsSetup", + "text": "FieldFormatsSetup" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": true, + "references": [] + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "data", + "id": "def-server.DataPluginStart", + "type": "Interface", + "tags": [], + "label": "DataPluginStart", + "description": [], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "ISearchStart", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" + }, + ", ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchResponse", + "text": "IEsSearchResponse" + }, + ">" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.fieldFormats", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "server", + "docId": "kibFieldFormatsPluginApi", + "section": "def-server.FieldFormatsStart", + "text": "FieldFormatsStart" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/plugin.ts" + } + ] + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.indexPatterns", + "type": "Object", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + } + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.DataPluginStart.datatableUtilities", + "type": "Object", + "tags": [], + "label": "datatableUtilities", + "description": [ + "\nDatatable type utility functions." + ], + "signature": [ + "DatatableUtilitiesService" + ], + "path": "src/plugins/data/server/plugin.ts", + "deprecated": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService", + "type": "Class", + "tags": [], + "label": "DatatableUtilitiesService", + "description": [], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.SavedObject.version", - "type": "string", + "id": "def-common.DatatableUtilitiesService.Unnamed", + "type": "Function", "tags": [], - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], + "label": "Constructor", + "description": [], "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.updated_at", - "type": "string", - "tags": [], - "label": "updated_at", - "description": [ - "Timestamp of the last time this document had been updated." + "any" ], - "signature": [ - "string | undefined" + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "aggs", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonStart", + "text": "AggsCommonStart" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsContract", + "text": "DataViewsContract" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "fieldFormats", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatsStartCommon", + "text": "FieldFormatsStartCommon" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.SavedObject.error", - "type": "Object", + "id": "def-common.DatatableUtilitiesService.clearField", + "type": "Function", "tags": [], - "label": "error", + "label": "clearField", "description": [], "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "T" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => void" ], - "signature": [ - "SavedObjectReference", - "[]" + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.clearField.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.SavedObject.migrationVersion", - "type": "Object", + "id": "def-common.DatatableUtilitiesService.clearFieldFormat", + "type": "Function", "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" - ], + "label": "clearFieldFormat", + "description": [], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => void" ], - "signature": [ - "string | undefined" + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.clearFieldFormat.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.SavedObject.namespaces", - "type": "Array", + "id": "def-common.DatatableUtilitiesService.getAggConfig", + "type": "Function", "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], + "label": "getAggConfig", + "description": [], "signature": [ - "string[] | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined>" ], - "signature": [ - "string | undefined" + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getAggConfig.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.UiSettingsCommon", - "type": "Interface", - "tags": [], - "label": "UiSettingsCommon", - "description": [ - "\nInterface for UiSettings common interface {@link UiSettingsClient}" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "children": [ + "returnComment": [] + }, { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.get", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta", "type": "Function", "tags": [], - "label": "get", + "label": "getDateHistogramMeta", "description": [ - "\nGet a setting value" + "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." ], "signature": [ - "(key: string) => Promise" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ", defaults?: Partial<{ timeZone: string; }>) => DateHistogramMeta | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.get.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [ - "name of value" + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getDateHistogramMeta.$2", + "type": "Object", + "tags": [], + "label": "defaults", + "description": [], "signature": [ - "string" + "Partial<{ timeZone: string; }>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -29522,65 +17396,154 @@ }, { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.getAll", + "id": "def-common.DatatableUtilitiesService.getDataView", "type": "Function", "tags": [], - "label": "getAll", - "description": [ - "\nGet all settings values" - ], + "label": "getDataView", + "description": [], "signature": [ - "() => Promise>" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getDataView.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set", + "id": "def-common.DatatableUtilitiesService.getField", "type": "Function", "tags": [], - "label": "set", - "description": [ - "\nSet a setting value" - ], + "label": "getField", + "description": [], "signature": [ - "(key: string, value: T) => Promise" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined>" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getField.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [ - "name of value" - ], + "label": "column", + "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getFieldFormat", + "type": "Function", + "tags": [], + "label": "getFieldFormat", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, + " | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.set.$2", - "type": "Uncategorized", + "id": "def-common.DatatableUtilitiesService.getFieldFormat.$1", + "type": "Object", "tags": [], - "label": "value", - "description": [ - "value to set" - ], + "label": "column", + "description": [], "signature": [ - "T" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "isRequired": true } @@ -29589,284 +17552,312 @@ }, { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.remove", + "id": "def-common.DatatableUtilitiesService.getInterval", "type": "Function", "tags": [], - "label": "remove", - "description": [ - "\nRemove a setting value" - ], + "label": "getInterval", + "description": [], "signature": [ - "(key: string) => Promise" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-common.UiSettingsCommon.remove.$1", - "type": "string", + "id": "def-common.DatatableUtilitiesService.getInterval.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [ - "name of value" - ], + "label": "column", + "description": [], "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "data", - "id": "def-common.DataViewType", - "type": "Enum", - "tags": [], - "label": "DataViewType", - "description": [ - "\nData View type. Default or rollup" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.ES_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "ES_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FilterStateStore", - "type": "Enum", - "tags": [], - "label": "FilterStateStore", - "description": [ - "\r\n Filter,\r\nAn enum to denote whether a filter is specific to an application's context or whether it should be applied globally." - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KBN_FIELD_TYPES", - "type": "Enum", - "tags": [], - "label": "KBN_FIELD_TYPES", - "description": [], - "path": "node_modules/@types/kbn__field-types/index.d.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-common.AggregationRestrictions", - "type": "Type", - "tags": [], - "label": "AggregationRestrictions", - "description": [], - "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.CSV_FORMULA_CHARS", - "type": "Array", - "tags": [], - "label": "CSV_FORMULA_CHARS", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/plugins/data/common/exports/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.CSV_MIME_TYPE", - "type": "string", - "tags": [], - "label": "CSV_MIME_TYPE", - "description": [], - "signature": [ - "\"text/plain;charset=utf-8\"" - ], - "path": "src/plugins/data/common/exports/export_csv.tsx", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DATA_VIEW_SAVED_OBJECT_TYPE", - "description": [ - "\nData view saved object type." - ], - "signature": [ - "\"index-pattern\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewFieldMap", - "type": "Type", - "tags": [], - "label": "DataViewFieldMap", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewsContract", - "type": "Type", - "tags": [], - "label": "DataViewsContract", - "description": [ - "\nData views service interface" - ], - "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; get: (id: string) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", - "SavedObject", - "<", - "DataViewSavedObjectAttrs", - ">[] | null | undefined>; getDefault: () => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "isRequired": true + } + ], + "returnComment": [] }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval", + "type": "Function", + "tags": [], + "label": "getNumberHistogramInterval", + "description": [ + "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." + ], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => number | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getNumberHistogramInterval.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getTotalCount", + "type": "Function", + "tags": [], + "label": "getTotalCount", + "description": [], + "signature": [ + "(table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => number | undefined" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.getTotalCount.$1", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - ", options?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.hasPrecisionError", + "type": "Function", + "tags": [], + "label": "hasPrecisionError", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => ", + "Serializable" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.hasPrecisionError.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - " | undefined) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.isFilterable", + "type": "Function", + "tags": [], + "label": "isFilterable", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => boolean" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.isFilterable.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "[]>; refreshFields: (indexPattern: ", + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.setFieldFormat", + "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [], + "signature": [ + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ", fieldFormat: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") => void" + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.setFieldFormat.$1", + "type": "Object", + "tags": [], + "label": "column", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DatatableUtilitiesService.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "fieldFormat", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "path": "src/plugins/data/common/datatable_utilities/datatable_utilities_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataView", + "type": "Class", + "tags": [], + "label": "DataView", + "description": [ + "\nData view class. Central kibana abstraction around multiple indices." + ], + "signature": [ { "pluginId": "dataViews", "scope": "common", @@ -29874,1518 +17865,5743 @@ "section": "def-common.DataView", "text": "DataView" }, - ") => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - "SavedObject", - "<", + " implements ", + "DataViewBase" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" + "parentPluginId": "data", + "id": "def-common.DataView.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ">) => ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "data", + "id": "def-common.DataView.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nTitle of data view" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - "; createAndSave: (spec: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" + "parentPluginId": "data", + "id": "def-common.DataView.fieldFormatMap", + "type": "Object", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nMap of field formats by field name" + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DataView.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ">; createSavedObject: (dataView: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DataView.fields", + "type": "CompoundType", + "tags": [], + "label": "fields", + "description": [ + "\nField list, in extended array format" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ", override?: boolean) => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DataView.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTimestamp field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ">; updateSavedObject: (indexPattern: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DataView.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nType is used to identify rollup index patterns." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise, deep?: boolean | undefined) => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + } + ], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.flattenHit.$1", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.flattenHit.$2", + "type": "CompoundType", + "tags": [], + "label": "deep", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false + } + ] }, - ">; getDefaultDataView: () => Promise<", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "parentPluginId": "data", + "id": "def-common.DataView.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [ + "\nList of meta fields by name" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - " | null>; }" - ], - "path": "src/plugins/data_views/common/data_views/data_views.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DataViewSpec", - "type": "Type", - "tags": [], - "label": "DataViewSpec", - "description": [ - "\nStatic data view format\nSerialized data object, representing data view attributes and state" - ], - "signature": [ - "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" + "parentPluginId": "data", + "id": "def-common.DataView.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nSavedObject version" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - "[] | undefined; fields?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" + "parentPluginId": "data", + "id": "def-common.DataView.sourceFilters", + "type": "Array", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nArray of filters - hides fields in discover" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - " | undefined; typeMeta?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "parentPluginId": "data", + "id": "def-common.DataView.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nArray of namespace ids" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false }, - " | undefined; type?: string | undefined; fieldFormats?: Record> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "parentPluginId": "data", + "id": "def-common.DataView.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "- config data and dependencies" + ], + "signature": [ + "DataViewDeps" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.DEFAULT_QUERY_LANGUAGE", - "type": "string", - "tags": [], - "label": "DEFAULT_QUERY_LANGUAGE", - "description": [], - "signature": [ - "\"kuery\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.EsQueryConfig", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "EsQueryConfig", - "description": [], - "signature": [ - "KueryQueryOptions", - " & { allowLeadingWildcards: boolean; queryStringOptions: ", - "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.ExistsFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "ExistsFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "FilterMeta", - "; query: { exists?: { field: string; } | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldAttrs", - "type": "Type", - "tags": [], - "label": "FieldAttrs", - "description": [ - "\nSet of field attributes" - ], - "signature": [ - "{ [key: string]: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" + "parentPluginId": "data", + "id": "def-common.DataView.getName", + "type": "Function", + "tags": [], + "label": "getName", + "description": [ + "\nGet name of Data View" + ], + "signature": [ + "() => string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - "; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldAttrSet", - "type": "Type", - "tags": [], - "label": "FieldAttrSet", - "description": [ - "\nField attributes that are stored on the data view" - ], - "signature": [ - "{ customLabel?: string | undefined; count?: number | undefined; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpec", - "type": "Type", - "tags": [], - "label": "FieldSpec", - "description": [ - "\nSerialized version of DataViewField" - ], - "signature": [ - "DataViewFieldBase", - " & { count?: number | undefined; conflictDescriptions?: Record | undefined; format?: ", { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "parentPluginId": "data", + "id": "def-common.DataView.getOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getOriginalSavedObjectBody", + "description": [ + "\nGet last saved saved object fields" + ], + "signature": [ + "() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - "<", - "SerializableRecord", - "> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; runtimeField?: ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSpec", - "text": "RuntimeFieldSpec" + "parentPluginId": "data", + "id": "def-common.DataView.resetOriginalSavedObjectBody", + "type": "Function", + "tags": [], + "label": "resetOriginalSavedObjectBody", + "description": [ + "\nReset last saved saved object fields. Used after saving." + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, - " | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FieldSpecConflictDescriptions", - "type": "Type", - "tags": [], - "label": "FieldSpecConflictDescriptions", - "description": [], - "signature": [ - "{ [x: string]: string[]; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.Filter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "Filter", - "description": [], - "signature": [ - "{ $state?: { store: ", - "FilterStateStore", - "; } | undefined; meta: ", - "FilterMeta", - "; query?: Record | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getFieldAttrs", + "type": "Function", + "tags": [], + "label": "getFieldAttrs", + "description": [ + "\nReturns field attributes map" + ], + "signature": [ + "() => { [x: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getComputedFields", + "type": "Function", + "tags": [], + "label": "getComputedFields", + "description": [ + "\nReturns scripted fields" + ], + "signature": [ + "() => { storedFields: string[]; scriptFields: Record; docvalueFields: { field: string; format: string; }[]; runtimeFields: ", + "MappingRuntimeFields", + "; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataView.toSpec", + "type": "Function", + "tags": [], + "label": "toSpec", + "description": [ + "\nCreates static representation of the data view." + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getSourceFiltering", + "type": "Function", + "tags": [], + "label": "getSourceFiltering", + "description": [ + "\nGet the source filtering configuration for that index." + ], + "signature": [ + "() => { excludes: string[]; }" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataView.removeScriptedField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "removeScriptedField", + "description": [ + "\nRemoves scripted field from field list." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/field_editor/field_editor.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } + ], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.removeScriptedField.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of scripted field to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getNonScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getNonScriptedFields", + "description": [ + "\n" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/source_filters_table/components/table/table.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "visTypeTimeseries", + "path": "src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts" + } + ], + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getScriptedFields", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getScriptedFields", + "description": [ + "\n" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": true, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_views.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" + }, + { + "plugin": "dataViewManagement", + "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/common/data_views/data_view.test.ts" + } + ], + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + "parentPluginId": "data", + "id": "def-common.DataView.isTimeBased", + "type": "Function", + "tags": [], + "label": "isTimeBased", + "description": [ + "\nDoes the data view have a timestamp field?" + ], + "signature": [ + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + "parentPluginId": "data", + "id": "def-common.DataView.isTimeNanosBased", + "type": "Function", + "tags": [], + "label": "isTimeNanosBased", + "description": [ + "\nDoes the data view have a timestamp field and is it a date nanos field?" + ], + "signature": [ + "() => this is ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TimeBasedDataView", + "text": "TimeBasedDataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getTimeField", + "type": "Function", + "tags": [], + "label": "getTimeField", + "description": [ + "\nGet timestamp field as DataViewField or return undefined" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getFieldByName", + "type": "Function", + "tags": [], + "label": "getFieldByName", + "description": [ + "\nGet field by name." + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.getFieldByName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getAggregationRestrictions", + "type": "Function", + "tags": [], + "label": "getAggregationRestrictions", + "description": [ + "\nGet aggregation restrictions. Rollup fields can only perform a subset of aggregations." + ], + "signature": [ + "() => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getAsSavedObjectBody", + "type": "Function", + "tags": [], + "label": "getAsSavedObjectBody", + "description": [ + "\nReturns index pattern as saved object body for saving" + ], + "signature": [ + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [ + "\nProvide a field, get its formatter" + ], + "signature": [ + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field to get formatter for" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + "parentPluginId": "data", + "id": "def-common.DataView.addRuntimeField", + "type": "Function", + "tags": [], + "label": "addRuntimeField", + "description": [ + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate." + ], + "signature": [ + "(name: string, runtimeField: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.addRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.addRuntimeField.$2", + "type": "Object", + "tags": [], + "label": "runtimeField", + "description": [ + "Runtime field definition" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.hasRuntimeField", + "type": "Function", + "tags": [], + "label": "hasRuntimeField", + "description": [ + "\nChecks if runtime field exists" + ], + "signature": [ + "(name: string) => boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.hasRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getRuntimeField", + "type": "Function", + "tags": [], + "label": "getRuntimeField", + "description": [ + "\nReturns runtime field if exists" + ], + "signature": [ + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " | null" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.getRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "Runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "getAllRuntimeFields", + "description": [ + "\nGet all runtime field definitions." + ], + "signature": [ + "() => Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "map of runtime field definitions by field name" + ] }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getFieldsByRuntimeFieldName", + "type": "Function", + "tags": [], + "label": "getFieldsByRuntimeFieldName", + "description": [ + "\nReturns data view fields backed by runtime fields." + ], + "signature": [ + "(name: string) => Record | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.getFieldsByRuntimeFieldName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "runtime field name" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "map of DataViewFields (that are runtime fields) by field name" + ] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "parentPluginId": "data", + "id": "def-common.DataView.replaceAllRuntimeFields", + "type": "Function", + "tags": [], + "label": "replaceAllRuntimeFields", + "description": [ + "\nReplaces all existing runtime fields with new fields." + ], + "signature": [ + "(newFields: Record) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.replaceAllRuntimeFields.$1", + "type": "Object", + "tags": [], + "label": "newFields", + "description": [ + "Map of runtime field definitions by field name" + ], + "signature": [ + "Record" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "parentPluginId": "data", + "id": "def-common.DataView.removeRuntimeField", + "type": "Function", + "tags": [], + "label": "removeRuntimeField", + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes." + ], + "signature": [ + "(name: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.removeRuntimeField.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "- Field name to remove" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getRuntimeMappings", + "type": "Function", + "tags": [], + "label": "getRuntimeMappings", + "description": [ + "\nReturn the \"runtime_mappings\" section of the ES search query." + ], + "signature": [ + "() => ", + "MappingRuntimeFields" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForFieldNoDefault", + "type": "Function", + "tags": [], + "label": "getFormatterForFieldNoDefault", + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists." + ], + "signature": [ + "(fieldname: string) => ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.getFormatterForFieldNoDefault.$1", + "type": "string", + "tags": [], + "label": "fieldname", + "description": [ + "name of field to get formatter for" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + "parentPluginId": "data", + "id": "def-common.DataView.setFieldAttrs", + "type": "Function", + "tags": [], + "label": "setFieldAttrs", + "description": [ + "\nSet field attribute" + ], + "signature": [ + "(fieldName: string, attrName: K, value: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldAttrs.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set attribute on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldAttrs.$2", + "type": "Uncategorized", + "tags": [], + "label": "attrName", + "description": [ + "name of attribute to set" + ], + "signature": [ + "K" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldAttrs.$3", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value of attribute" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" + }, + "[K]" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.FilterMeta", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "FilterMeta", - "description": [], - "signature": [ - "{ alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.GetConfigFn", - "type": "Type", - "tags": [], - "label": "GetConfigFn", - "description": [ - "\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible." - ], - "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ { "parentPluginId": "data", - "id": "def-common.GetConfigFn.$1", - "type": "string", + "id": "def-common.DataView.setFieldCustomLabel", + "type": "Function", "tags": [], - "label": "key", - "description": [], - "path": "src/plugins/data/common/types.ts", - "deprecated": false + "label": "setFieldCustomLabel", + "description": [ + "\nSet field custom label" + ], + "signature": [ + "(fieldName: string, customLabel: string | null | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldCustomLabel.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set custom label on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldCustomLabel.$2", + "type": "CompoundType", + "tags": [], + "label": "customLabel", + "description": [ + "custom label value. If undefined, custom label is removed" + ], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-common.GetConfigFn.$2", - "type": "Uncategorized", + "id": "def-common.DataView.setFieldCount", + "type": "Function", "tags": [], - "label": "defaultOverride", - "description": [], + "label": "setFieldCount", + "description": [ + "\nSet field count" + ], "signature": [ - "T | undefined" + "(fieldName: string, count: number | null | undefined) => void" ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", - "type": "Type", - "tags": [], - "label": "IndexPatternLoadExpressionFunctionDefinition", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"indexPatternLoad\", null, Arguments, Output, ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", - "type": "string", - "tags": [], - "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", - "description": [], - "signature": [ - "\"kibana.userQueryLanguage\"" - ], - "path": "src/plugins/data/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.MatchAllFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "MatchAllFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: MatchAllFilterMeta; query: { match_all: ", - "QueryDslMatchAllQuery", - "; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.META_FIELDS", - "type": "string", - "tags": [], - "label": "META_FIELDS", - "description": [ - "\nUiSettings key for metaFields list." - ], - "signature": [ - "\"metaFields\"" - ], - "path": "src/plugins/data_views/common/constants.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.PhraseFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "PhraseFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: PhraseFilterMeta; query: { match_phrase?: Partial> | undefined; match?: Partial> | undefined; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.Query", - "type": "Type", - "tags": [], - "label": "Query", - "description": [], - "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" - ], - "path": "node_modules/@types/kbn__es-query/index.d.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.RangeFilter", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "RangeFilter", - "description": [], - "signature": [ - "Filter", - " & { meta: ", - "RangeFilterMeta", - "; query: { range: { [key: string]: ", - "RangeFilterParams", - "; }; }; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.RangeFilterParams", - "type": "Type", - "tags": [ - "deprecated" + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldCount.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set count on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldCount.$2", + "type": "CompoundType", + "tags": [], + "label": "count", + "description": [ + "count value. If undefined, count is removed" + ], + "signature": [ + "number | null | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldFormat", + "type": "Function", + "tags": [], + "label": "setFieldFormat", + "description": [ + "\nSet field formatter" + ], + "signature": [ + "(fieldName: string, format: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + "SerializableRecord", + ">) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "name of field to set format on" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.setFieldFormat.$2", + "type": "Object", + "tags": [], + "label": "format", + "description": [ + "field format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + "SerializableRecord", + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.DataView.deleteFieldFormat", + "type": "Function", + "tags": [], + "label": "deleteFieldFormat", + "description": [ + "\nRemove field format from the field format map." + ], + "signature": [ + "(fieldName: string) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataView.deleteFieldFormat.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "field name associated with the format for removal" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_view.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } ], - "label": "RangeFilterParams", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-common.SourceFilter", - "type": "Type", + "id": "def-common.DataViewField", + "type": "Class", "tags": [], - "label": "SourceFilter", - "description": [], - "signature": [ - "{ value: string; }" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.TimeRange", - "type": "Type", - "tags": [ - "deprecated", - "deprecated" - ], - "label": "TimeRange", + "label": "DataViewField", "description": [ - "\n" + "\nData view field class" ], "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ - { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/locator.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/locator.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/search_embeddable_factory.ts" - }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/layout/types.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/public/application/main/components/top_nav/discover_topnav.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/types.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + " implements ", + "DataViewFieldBase" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/filter_utils.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.spec", + "type": "CompoundType", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + "DataViewFieldBase", + " & { count?: number | undefined; conflictDescriptions?: Record | undefined; format?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + "SerializableRecord", + "> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; runtimeField?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.Unnamed", + "type": "Function", + "tags": [ + "constructor" + ], + "label": "Constructor", + "description": [ + "\nDataView constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewField.Unnamed.$1", + "type": "CompoundType", + "tags": [], + "label": "spec", + "description": [ + "Configuration for the field" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/state/dashboard_state_slice.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nCount is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nSet count, which is used for field popularity in discover." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.runtimeField", + "type": "CompoundType", + "tags": [], + "label": "runtimeField", + "description": [ + "\nReturns runtime field definition or undefined if field is not runtime field." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.runtimeField", + "type": "CompoundType", + "tags": [], + "label": "runtimeField", + "description": [ + "\nSets runtime field definition or unsets if undefined is provided." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nScript field code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.script", + "type": "string", + "tags": [], + "label": "script", + "description": [ + "\nSets scripted field painless code" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nScript field language" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.lang", + "type": "string", + "tags": [], + "label": "lang", + "description": [ + "\nSets scripted field langauge." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nReturns custom label if set, otherwise undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/top_nav/show_share_modal.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nSets custom label for field, or unsets if passed undefined." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "controls", - "path": "src/plugins/controls/public/services/kibana/options_list.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.conflictDescriptions", + "type": "Object", + "tags": [], + "label": "conflictDescriptions", + "description": [ + "\nSets conflict descriptions for field." + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nGet field name" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/locator.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [ + "\nGets display name, calcualted based on name, custom label and shortDotsEnable." + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nGets field type" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [ + "\nGets ES types as string array" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.scripted", + "type": "boolean", + "tags": [], + "label": "scripted", + "description": [ + "\nReturns true if scripted field" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.searchable", + "type": "boolean", + "tags": [], + "label": "searchable", + "description": [ + "\nReturns true if field is searchable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.aggregatable", + "type": "boolean", + "tags": [], + "label": "aggregatable", + "description": [ + "\nReturns true if field is aggregatable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.readFromDocValues", + "type": "boolean", + "tags": [], + "label": "readFromDocValues", + "description": [ + "\nReturns true if field is available via doc values" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.subType", + "type": "CompoundType", + "tags": [], + "label": "subType", + "description": [ + "\nReturns field subtype, multi, nested, or undefined if neither" + ], + "signature": [ + "IFieldSubType", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.isMapped", + "type": "CompoundType", + "tags": [], + "label": "isMapped", + "description": [ + "\nIs the field part of the index mapping?" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.isRuntimeField", + "type": "boolean", + "tags": [], + "label": "isRuntimeField", + "description": [ + "\nReturns true if runtime field defined on data view" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.sortable", + "type": "boolean", + "tags": [], + "label": "sortable", + "description": [ + "\nReturns true if field is sortable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.filterable", + "type": "boolean", + "tags": [], + "label": "filterable", + "description": [ + "\nReturns true if field is filterable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.visualizable", + "type": "boolean", + "tags": [], + "label": "visualizable", + "description": [ + "\nReturns true if field is visualizable" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewField.isSubtypeNested", + "type": "Function", + "tags": [], + "label": "isSubtypeNested", + "description": [ + "\nReturns true if field is subtype nested" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.isSubtypeMulti", + "type": "Function", + "tags": [], + "label": "isSubtypeMulti", + "description": [ + "\nReturns true if field is subtype multi" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/reducers/map/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.getSubtypeNested", + "type": "Function", + "tags": [], + "label": "getSubtypeNested", + "description": [ + "\nReturns subtype nested data if exists" + ], + "signature": [ + "() => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.getSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getSubtypeMulti", + "description": [ + "\nReturns subtype multi data if exists" + ], + "signature": [ + "() => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/selectors/map_selectors.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.deleteCount", + "type": "Function", + "tags": [], + "label": "deleteCount", + "description": [ + "\nDeletes count value. Popularity as used by discover" + ], + "signature": [ + "() => void" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.toJSON", + "type": "Function", + "tags": [], + "label": "toJSON", + "description": [ + "\nJSON version of field" + ], + "signature": [ + "() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ", + "IFieldSubType", + " | undefined; customLabel: string | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/actions/map_actions.ts" + "parentPluginId": "data", + "id": "def-common.DataViewField.toSpec", + "type": "Function", + "tags": [], + "label": "toSpec", + "description": [ + "\nGet field in serialized form - fieldspec." + ], + "signature": [ + "(config?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewField.toSpec.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "provide a method to get a field formatter" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.ToSpecConfig", + "text": "ToSpecConfig" + } + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "field in serialized form - field spec" + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DataViewField.isRuntimeCompositeSubField", + "type": "Function", + "tags": [], + "label": "isRuntimeCompositeSubField", + "description": [ + "\nReturns true if composite runtime field" + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/data_views/common/fields/data_view_field.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError", + "type": "Class", + "tags": [], + "label": "DataViewSavedObjectConflictError", + "description": [ + "\nError thrown when saved object has been changed when attempting to save." + ], + "signature": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSavedObjectConflictError", + "text": "DataViewSavedObjectConflictError" }, + " extends Error" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" - }, + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewSavedObjectConflictError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [ + "saved object id with conflict" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/data_view_saved_object_conflict.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService", + "type": "Class", + "tags": [], + "label": "DataViewsService", + "description": [ + "\nData views service, providing CRUD operations for data views." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getCanSave", + "type": "Function", + "tags": [], + "label": "getCanSave", + "description": [ + "\nCan the user save data views?" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "returnComment": [], + "children": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nDataViewsService constructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [ + "Service dependencies" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewsServiceDeps", + "text": "DataViewsServiceDeps" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIds", + "type": "Function", + "tags": [], + "label": "getIds", + "description": [ + "\nGets list of index pattern ids." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIds.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getTitles", + "type": "Function", + "tags": [], + "label": "getTitles", + "description": [ + "\nGets list of index pattern titles." + ], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getTitles.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/index.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind and load index patterns by title." + ], + "signature": [ + "(search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.find.$1", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search string" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.find.$2", + "type": "number", + "tags": [], + "label": "size", + "description": [ + "Number of data views to return" + ], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView[]" + ] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIdsWithTitle", + "type": "Function", + "tags": [], + "label": "getIdsWithTitle", + "description": [ + "\nGets list of index pattern ids with titles." + ], + "signature": [ + "(refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getIdsWithTitle.$1", + "type": "boolean", + "tags": [], + "label": "refresh", + "description": [ + "Force refresh of index pattern list" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.clearCache", + "type": "Function", + "tags": [], + "label": "clearCache", + "description": [ + "\nClear index pattern list cache." + ], + "signature": [ + "(id?: string | undefined) => void" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.clearCache.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "optionally clear a single id" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getCache", + "type": "Function", + "tags": [], + "label": "getCache", + "description": [ + "\nGet cache, contains data view saved objects." + ], + "signature": [ + "() => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefault", + "type": "Function", + "tags": [], + "label": "getDefault", + "description": [ + "\nGet default index pattern" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefaultId", + "type": "Function", + "tags": [], + "label": "getDefaultId", + "description": [ + "\nGet default index pattern id" + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/locators.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault", + "type": "Function", + "tags": [], + "label": "setDefault", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "signature": [ + "(id: string | null, force?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault.$1", + "type": "CompoundType", + "tags": [], + "label": "id", + "description": [ + "data view id" + ], + "signature": [ + "string | null" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.setDefault.$2", + "type": "boolean", + "tags": [], + "label": "force", + "description": [ + "set default data view even if there's an existing default" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.hasUserDataView", + "type": "Function", + "tags": [], + "label": "hasUserDataView", + "description": [ + "\nChecks if current user has a user created index pattern ignoring fleet's server default index patterns." + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForWildcard", + "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [ + "\nGet field list by providing { pattern }." + ], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "FieldSpec[]" + ] }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern", + "type": "Function", + "tags": [], + "label": "getFieldsForIndexPattern", + "description": [ + "\nGet field list by providing an index patttern (or spec)." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$1", + "type": "CompoundType", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.getFieldsForIndexPattern.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "options for getting field list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "FieldSpec[]" + ] }, { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.refreshFields", + "type": "Function", + "tags": [], + "label": "refreshFields", + "description": [ + "\nRefresh field list for a given index pattern." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ") => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.refreshFields.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap", + "type": "Function", + "tags": [], + "label": "fieldArrayToMap", + "description": [ + "\nConverts field array to map." + ], + "signature": [ + "(fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap.$1", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + ": FieldSpec[]" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.fieldArrayToMap.$2", + "type": "Object", + "tags": [], + "label": "fieldAttrs", + "description": [ + ": FieldAttrs" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "Record" + ] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.savedObjectToSpec", + "type": "Function", + "tags": [], + "label": "savedObjectToSpec", + "description": [ + "\nConverts data view saved object to data view spec." + ], + "signature": [ + "(savedObject: ", + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.savedObjectToSpec.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataViewSpec" + ] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGet an index pattern by id, cache optimized." + ], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nCreate a new data view instance." + ], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.create.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.create.$2", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "if true, will not fetch fields" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "DataView" + ] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave", + "type": "Function", + "tags": [], + "label": "createAndSave", + "description": [ + "\nCreate a new data view and save it right away." + ], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [ + "data view spec" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createAndSave.$3", + "type": "boolean", + "tags": [], + "label": "skipFetchFields", + "description": [ + "Whether to skip field refresh step." + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts" + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject", + "type": "Function", + "tags": [], + "label": "createSavedObject", + "description": [ + "\nSave a new data view." + ], + "signature": [ + "(dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", override?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject.$1", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "data view instance" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.createSavedObject.$2", + "type": "boolean", + "tags": [], + "label": "override", + "description": [ + "Overwrite if existing index pattern exists" + ], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject", + "type": "Function", + "tags": [], + "label": "updateSavedObject", + "description": [ + "\nSave existing dat aview. Will attempt to merge differences if there are conflicts." + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$2", + "type": "number", + "tags": [], + "label": "saveAttempts", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.updateSavedObject.$3", + "type": "boolean", + "tags": [], + "label": "ignoreErrors", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewsService.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes an index pattern from .kibana index." + ], + "signature": [ + "(indexPatternId: string) => Promise<{}>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewsService.delete.$1", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [ + ": Id of kibana Index Pattern to delete" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DataViewsService.getDefaultDataView", + "type": "Function", + "tags": [], + "label": "getDefaultDataView", + "description": [ + "\nReturns the default data view as an object.\nIf no default is found, or it is missing\nanother data view is selected as default and returned.\nIf no possible data view found to become a default returns null.\n" + ], + "signature": [ + "() => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "default data view" + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError", + "type": "Class", + "tags": [], + "label": "DuplicateDataViewError", + "description": [ + "\nError thrown when attempting to create duplicate index pattern based on title." + ], + "signature": [ { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DuplicateDataViewError", + "text": "DuplicateDataViewError" }, + " extends Error" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "children": [ { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nconstructor" + ], + "signature": [ + "any" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.DuplicateDataViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "- Error message" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/errors/duplicate_index_pattern.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.KbnFieldType", + "type": "Class", + "tags": [], + "label": "KbnFieldType", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "children": [ { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + "parentPluginId": "data", + "id": "def-common.KbnFieldType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx" + "parentPluginId": "data", + "id": "def-common.KbnFieldType.sortable", + "type": "boolean", + "tags": [], + "label": "sortable", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.KbnFieldType.filterable", + "type": "boolean", + "tags": [], + "label": "filterable", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx" + "parentPluginId": "data", + "id": "def-common.KbnFieldType.esTypes", + "type": "Object", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "readonly ", + "ES_FIELD_TYPES", + "[]" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, + "parentPluginId": "data", + "id": "def-common.KbnFieldType.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.KbnFieldType.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Partial<", + "KbnFieldTypeOptions", + "> | undefined" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "data", + "id": "def-common.cellHasFormulas", + "type": "Function", + "tags": [], + "label": "cellHasFormulas", + "description": [], + "signature": [ + "(val: string) => boolean" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false, + "children": [ { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" - }, + "parentPluginId": "data", + "id": "def-common.cellHasFormulas.$1", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.createEscapeValue", + "type": "Function", + "tags": [], + "label": "createEscapeValue", + "description": [ + "\nCreate a function that will escape CSV values like \"=\", \"@\" and \"+\" with a\n\"'\". This will also place CSV values in \"\" if contain non-alphanumeric chars.\n\nFor example:\n\nGiven: =1+1\nReturns: \"'=1+1\"\n\nSee OWASP: https://www.owasp.org/index.php/CSV_Injection." + ], + "signature": [ + "(quoteValues: boolean, escapeFormulas: boolean) => (val: RawValue) => string" + ], + "path": "src/plugins/data/common/exports/escape_value.ts", + "deprecated": false, + "children": [ { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + "parentPluginId": "data", + "id": "def-common.createEscapeValue.$1", + "type": "boolean", + "tags": [], + "label": "quoteValues", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data/common/exports/escape_value.ts", + "deprecated": false, + "isRequired": true }, { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" - }, + "parentPluginId": "data", + "id": "def-common.createEscapeValue.$2", + "type": "boolean", + "tags": [], + "label": "escapeFormulas", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data/common/exports/escape_value.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.datatableToCSV", + "type": "Function", + "tags": [], + "label": "datatableToCSV", + "description": [], + "signature": [ + "({ columns, rows }: ", { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" }, + ", { csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }: CSVOptions) => string" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false, + "children": [ { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" + "parentPluginId": "data", + "id": "def-common.datatableToCSV.$1", + "type": "Object", + "tags": [], + "label": "{ columns, rows }", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false, + "isRequired": true }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/embeddables.ts" - }, + "parentPluginId": "data", + "id": "def-common.datatableToCSV.$2", + "type": "Object", + "tags": [], + "label": "{ csvSeparator, quoteValues, formatFactory, raw, escapeFormulaValues }", + "description": [], + "signature": [ + "CSVOptions" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.fieldList", + "type": "Function", + "tags": [], + "label": "fieldList", + "description": [], + "signature": [ + "(specs?: ", { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], shortDotsEnable?: boolean) => ", { - "plugin": "dashboardEnhanced", - "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx" - }, + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "children": [ { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" + "parentPluginId": "data", + "id": "def-common.fieldList.$1", + "type": "Array", + "tags": [], + "label": "specs", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true }, { - "plugin": "discoverEnhanced", - "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts" - }, + "parentPluginId": "data", + "id": "def-common.fieldList.$2", + "type": "boolean", + "tags": [], + "label": "shortDotsEnable", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getEsQueryConfig", + "type": "Function", + "tags": [], + "label": "getEsQueryConfig", + "description": [], + "signature": [ + "(config: KibanaConfig) => ", + "EsQueryConfig" + ], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, + "children": [ { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, + "parentPluginId": "data", + "id": "def-common.getEsQueryConfig.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "KibanaConfig" + ], + "path": "src/plugins/data/common/es_query/get_es_query_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeMulti", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/url_state.ts" - }, + "parentPluginId": "data", + "id": "def-common.getFieldSubtypeMulti.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getFieldSubtypeNested", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeNested", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + "IFieldSubTypeNested", + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" - }, + "parentPluginId": "data", + "id": "def-common.getFieldSubtypeNested.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getIndexPatternLoadMeta", + "type": "Function", + "tags": [], + "label": "getIndexPatternLoadMeta", + "description": [], + "signature": [ + "() => Omit<", { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "text": "IndexPatternLoadExpressionFunctionDefinition" }, + ", \"fn\">" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isFilterable", + "type": "Function", + "tags": [], + "label": "isFilterable", + "description": [], + "signature": [ + "(field: ", { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + ") => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "children": [ { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, + "parentPluginId": "data", + "id": "def-common.isFilterable.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isMultiField", + "type": "Function", + "tags": [], + "label": "isMultiField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx" - }, + "parentPluginId": "data", + "id": "def-common.isMultiField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isNestedField", + "type": "Function", + "tags": [], + "label": "isNestedField", + "description": [], + "signature": [ + "(field: HasSubtype) => boolean" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" - }, + "parentPluginId": "data", + "id": "def-common.isNestedField.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "{ subType?: ", + "IFieldSubType", + " | undefined; }" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.tableHasFormulas", + "type": "Function", + "tags": [], + "label": "tableHasFormulas", + "description": [], + "signature": [ + "(columns: ", { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, + "[], rows: ", { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" }, + "[]) => boolean" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false, + "children": [ { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" + "parentPluginId": "data", + "id": "def-common.tableHasFormulas.$1", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false, + "isRequired": true }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" - }, + "parentPluginId": "data", + "id": "def-common.tableHasFormulas.$2", + "type": "Array", + "tags": [], + "label": "rows", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + "[]" + ], + "path": "src/plugins/data/common/exports/formula_checks.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewAttributes", + "type": "Interface", + "tags": [], + "label": "DataViewAttributes", + "description": [ + "\nInterface for the data view saved object" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.fields", + "type": "string", + "tags": [], + "label": "fields", + "description": [ + "\nFields as a serialized array of field specs" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nData view type, default or rollup" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "urlDrilldown", - "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.typeMeta", + "type": "string", + "tags": [], + "label": "typeMeta", + "description": [ + "\nType metadata information, serialized. Only used by rollup data views." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.timeFieldName", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [ + "\nTime field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.sourceFilters", + "type": "string", + "tags": [], + "label": "sourceFilters", + "description": [ + "\nSerialized array of filters. Used by discover to hide fields." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.fieldFormatMap", + "type": "string", + "tags": [], + "label": "fieldFormatMap", + "description": [ + "\nSerialized map of field formats by field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.fieldAttrs", + "type": "string", + "tags": [], + "label": "fieldAttrs", + "description": [ + "\nSerialized map of field attributes, currently field count and name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.runtimeFieldMap", + "type": "string", + "tags": [], + "label": "runtimeFieldMap", + "description": [ + "\nSerialized map of runtime field definitions, by field name" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [ + "\nPrevents errors when index pattern exists before indices" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_container.ts" - }, + "parentPluginId": "data", + "id": "def-common.DataViewAttributes.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the data view. Human readable name used to differentiate data view." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewListItem", + "type": "Interface", + "tags": [], + "label": "DataViewListItem", + "description": [ + "\nResult from data view search - summary data." + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewListItem.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nSaved object id" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewListItem.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nNamespace ids" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewListItem.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nData view title" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/agg_group.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewListItem.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nData view type" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" + "parentPluginId": "data", + "id": "def-common.DataViewListItem.typeMeta", + "type": "Object", + "tags": [], + "label": "typeMeta", + "description": [ + "\nData view type meta" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx" - }, + "parentPluginId": "data", + "id": "def-common.DataViewListItem.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FilterValueFormatter", + "type": "Interface", + "tags": [], + "label": "FilterValueFormatter", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" + "parentPluginId": "data", + "id": "def-common.FilterValueFormatter.convert", + "type": "Function", + "tags": [], + "label": "convert", + "description": [], + "signature": [ + "(value: any) => string" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FilterValueFormatter.convert.$1", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ] }, { - "plugin": "visDefaultEditor", - "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" - }, + "parentPluginId": "data", + "id": "def-common.FilterValueFormatter.getConverterFor", + "type": "Function", + "tags": [], + "label": "getConverterFor", + "description": [], + "signature": [ + "(type: string) => FilterFormatterFunction" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FilterValueFormatter.getConverterFor.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions", + "type": "Interface", + "tags": [], + "label": "GetFieldsOptions", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "uiActionsEnhanced", - "path": "src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable_factory.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.lookBack", + "type": "CompoundType", + "tags": [], + "label": "lookBack", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/timelion_vis_fn.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.rollupIndex", + "type": "string", + "tags": [], + "label": "rollupIndex", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visTypeTimelion", - "path": "src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts" + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false }, { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" - }, + "parentPluginId": "data", + "id": "def-common.GetFieldsOptions.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IDataViewsApiClient", + "type": "Interface", + "tags": [], + "label": "IDataViewsApiClient", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "visTypeTimeseries", - "path": "src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx" + "parentPluginId": "data", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", + "type": "Function", + "tags": [], + "label": "getFieldsForWildcard", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" - }, + "parentPluginId": "data", + "id": "def-common.IDataViewsApiClient.hasUserIndexPattern", + "type": "Function", + "tags": [], + "label": "hasUserIndexPattern", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternExpressionType", + "type": "Interface", + "tags": [], + "label": "IndexPatternExpressionType", + "description": [ + "\nIndex pattern expression interface" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "children": [ { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_fn.ts" + "parentPluginId": "data", + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nExpression type" + ], + "signature": [ + "\"index_pattern\"" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false }, { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" - }, + "parentPluginId": "data", + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", + "tags": [], + "label": "value", + "description": [ + "\nValue - DataViewSpec" + ], + "signature": [ + "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined; fields?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + " | undefined; typeMeta?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined; type?: string | undefined; fieldFormats?: Record> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions", + "type": "Interface", + "tags": [], + "label": "KbnFieldTypeOptions", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "children": [ { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/vega_request_handler.ts" + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions.sortable", + "type": "boolean", + "tags": [], + "label": "sortable", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx" + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions.filterable", + "type": "boolean", + "tags": [], + "label": "filterable", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false }, { - "plugin": "visualizations", - "path": "src/plugins/visualizations/common/locator.ts" - }, + "parentPluginId": "data", + "id": "def-common.KbnFieldTypeOptions.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "ES_FIELD_TYPES", + "[]" + ], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SavedObject", + "type": "Interface", + "tags": [], + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "children": [ { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "controls", - "path": "src/plugins/controls/common/types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "controls", - "path": "src/plugins/controls/common/control_types/options_list/types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.updated_at", + "type": "string", + "tags": [], + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "T" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "cases", - "path": "x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" + "parentPluginId": "data", + "id": "def-common.SavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts" - }, + "parentPluginId": "data", + "id": "def-common.SavedObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon", + "type": "Interface", + "tags": [], + "label": "UiSettingsCommon", + "description": [ + "\nInterface for UiSettings common interface {@link UiSettingsClient}" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGet a setting value" + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [ + "\nGet all settings values" + ], + "signature": [ + "() => Promise>" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nSet a setting value" + ], + "signature": [ + "(key: string, value: T) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.set.$2", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "value to set" + ], + "signature": [ + "T" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" - }, + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemove a setting value" + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.UiSettingsCommon.remove.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "name of value" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "data", + "id": "def-common.DataViewType", + "type": "Enum", + "tags": [], + "label": "DataViewType", + "description": [ + "\nData View type. Default or rollup" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.ES_FIELD_TYPES", + "type": "Enum", + "tags": [], + "label": "ES_FIELD_TYPES", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.KBN_FIELD_TYPES", + "type": "Enum", + "tags": [], + "label": "KBN_FIELD_TYPES", + "description": [], + "path": "node_modules/@types/kbn__field-types/index.d.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "data", + "id": "def-common.AggregationRestrictions", + "type": "Type", + "tags": [], + "label": "AggregationRestrictions", + "description": [], + "signature": [ + "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.CSV_FORMULA_CHARS", + "type": "Array", + "tags": [], + "label": "CSV_FORMULA_CHARS", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/common/exports/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.CSV_MIME_TYPE", + "type": "string", + "tags": [], + "label": "CSV_MIME_TYPE", + "description": [], + "signature": [ + "\"text/plain;charset=utf-8\"" + ], + "path": "src/plugins/data/common/exports/export_csv.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DATA_VIEW_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "DATA_VIEW_SAVED_OBJECT_TYPE", + "description": [ + "\nData view saved object type." + ], + "signature": [ + "\"index-pattern\"" + ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewFieldMap", + "type": "Type", + "tags": [], + "label": "DataViewFieldMap", + "description": [], + "signature": [ + "{ [x: string]: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewsContract", + "type": "Type", + "tags": [], + "label": "DataViewsContract", + "description": [ + "\nData views service interface" + ], + "signature": [ + "{ create: (spec: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + ", skipFetchFields?: boolean) => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_fn.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + "[]>; get: (id: string) => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" }, + "[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<", + "SavedObject", + "<", + "DataViewSavedObjectAttrs", + ">[] | null | undefined>; getDefault: () => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/timeslider/timeslider.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, + ") => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]>; getFieldsForIndexPattern: (indexPattern: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " | ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + ", options?: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, + " | undefined) => Promise<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/map_component.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[]>; refreshFields: (indexPattern: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ") => Promise; fieldArrayToMap: (fields: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/region_map/region_map_visualization.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], fieldAttrs?: ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, + " | undefined) => ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_fn.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" }, + "; savedObjectToSpec: (savedObject: ", + "SavedObject", + "<", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" }, + ">) => ", { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/legacy_visualizations/tile_map/tile_map_visualization.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + "; createAndSave: (spec: ", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" }, + ", override?: boolean, skipFetchFields?: boolean) => Promise<", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; createSavedObject: (dataView: ", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ", override?: boolean) => Promise<", { - "plugin": "dataVisualizer", - "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ">; updateSavedObject: (indexPattern: ", { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise; getDefaultDataView: () => Promise<", { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/date_utils.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + " | null>; }" + ], + "path": "src/plugins/data_views/common/data_views/data_views.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DataViewSpec", + "type": "Type", + "tags": [], + "label": "DataViewSpec", + "description": [ + "\nStatic data view format\nSerialized data object, representing data view attributes and state" + ], + "signature": [ + "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" }, + "[] | undefined; fields?: ", { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" }, + " | undefined; typeMeta?: ", { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/embeddables/types.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" }, + " | undefined; type?: string | undefined; fieldFormats?: Record> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, + " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "tags": [], + "label": "DEFAULT_QUERY_LANGUAGE", + "description": [], + "signature": [ + "\"kuery\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FieldAttrs", + "type": "Type", + "tags": [], + "label": "FieldAttrs", + "description": [ + "\nSet of field attributes" + ], + "signature": [ + "{ [key: string]: ", { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, + "; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FieldAttrSet", + "type": "Type", + "tags": [], + "label": "FieldAttrSet", + "description": [ + "\nField attributes that are stored on the data view" + ], + "signature": [ + "{ customLabel?: string | undefined; count?: number | undefined; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FieldSpec", + "type": "Type", + "tags": [], + "label": "FieldSpec", + "description": [ + "\nSerialized version of DataViewField" + ], + "signature": [ + "DataViewFieldBase", + " & { count?: number | undefined; conflictDescriptions?: Record | undefined; format?: ", { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts" + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, + "<", + "SerializableRecord", + "> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; runtimeField?: ", { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" }, + " | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.FieldSpecConflictDescriptions", + "type": "Type", + "tags": [], + "label": "FieldSpecConflictDescriptions", + "description": [], + "signature": [ + "{ [x: string]: string[]; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.GetConfigFn", + "type": "Type", + "tags": [], + "label": "GetConfigFn", + "description": [ + "\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible." + ], + "signature": [ + "(key: string, defaultOverride?: T | undefined) => T" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/public/functions/timelion.ts" + "parentPluginId": "data", + "id": "def-common.GetConfigFn.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false }, { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" - }, + "parentPluginId": "data", + "id": "def-common.GetConfigFn.$2", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "type": "Type", + "tags": [], + "label": "IndexPatternLoadExpressionFunctionDefinition", + "description": [], + "signature": [ { - "plugin": "lens", - "path": "x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, + "<\"indexPatternLoad\", null, Arguments, Output, ", { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, + "<", { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/time_cache.ts" - } + ", ", + "SerializableRecord", + ">>" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", + "type": "string", + "tags": [], + "label": "KIBANA_USER_QUERY_LANGUAGE_KEY", + "description": [], + "signature": [ + "\"kibana.userQueryLanguage\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.META_FIELDS", + "type": "string", + "tags": [], + "label": "META_FIELDS", + "description": [ + "\nUiSettings key for metaFields list." + ], + "signature": [ + "\"metaFields\"" ], + "path": "src/plugins/data_views/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@types/kbn__es-query/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.SourceFilter", + "type": "Type", + "tags": [], + "label": "SourceFilter", + "description": [], + "signature": [ + "{ value: string; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, "initialIsOpen": false }, { @@ -31428,24 +23644,6 @@ } ], "objects": [ - { - "parentPluginId": "data", - "id": "def-common.COMPARE_ALL_OPTIONS", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "COMPARE_ALL_OPTIONS", - "description": [], - "signature": [ - "FilterCompareOptions" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.DEFAULT_ASSETS_TO_IGNORE", @@ -31521,55 +23719,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.FILTERS", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "FILTERS", - "description": [], - "signature": [ - "typeof ", - "FILTERS" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.nodeBuilder", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "nodeBuilder", - "description": [], - "signature": [ - "{ is: (fieldName: string, value: string | ", - "KueryNode", - ") => ", - "FunctionTypeBuildNode", - "; or: (nodes: ", - "KueryNode", - "[]) => ", - "KueryNode", - "; and: (nodes: ", - "KueryNode", - "[]) => ", - "KueryNode", - "; }" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.RUNTIME_FIELD_TYPES", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 3ba5beb5d04d8..9e2ff20a26ccb 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3372 | 35 | 2518 | 21 | +| 3072 | 34 | 2399 | 22 | ## Client diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index ba274a046a393..e888da21c8a41 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -1921,13 +1921,7 @@ "label": "time", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", @@ -3583,13 +3577,7 @@ "description": [], "signature": [ "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", "deprecated": false, @@ -3843,13 +3831,7 @@ ], "signature": [ "{ time?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; refreshInterval?: ", { "pluginId": "data", @@ -3890,13 +3872,7 @@ "label": "SavedQueryTimeFilter", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " & { refreshInterval: ", { "pluginId": "data", diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 2a81780f25e56..97cb36245b0df 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3372 | 35 | 2518 | 21 | +| 3072 | 34 | 2399 | 22 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index deba3008b0de7..b238ea5ef4fcf 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -420,13 +420,7 @@ ], "signature": [ "{ calculateAutoTimeExpression: (range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", @@ -12282,13 +12276,7 @@ "description": [], "signature": [ "(getConfig: (key: string) => any) => (range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", @@ -15721,13 +15709,7 @@ "description": [], "signature": [ "(timerange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => ", { "pluginId": "expressions", @@ -15748,13 +15730,7 @@ "label": "timerange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", "deprecated": false, @@ -20909,13 +20885,7 @@ "description": [], "signature": [ "(range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined" ], "path": "src/plugins/data/common/search/aggs/types.ts", @@ -25238,13 +25208,7 @@ "description": [], "signature": [ "{ calculateAutoTimeExpression: (range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", @@ -26683,13 +26647,7 @@ ], "signature": [ "{ calculateAutoTimeExpression: (range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => string | undefined; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", @@ -27367,13 +27325,7 @@ " | ", "Query", "[] | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", @@ -27973,13 +27925,7 @@ "text": "ExpressionFunctionDefinition" }, "<\"timerange\", null, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ", ", { "pluginId": "data", @@ -29485,13 +29431,7 @@ "description": [], "signature": [ "{ type: \"timerange\"; } & ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, @@ -32857,13 +32797,7 @@ "description": [], "signature": [ "(input: null, args: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", ") => { type: \"timerange\"; from: string; to: string; mode: \"absolute\" | \"relative\" | undefined; }" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", @@ -32891,13 +32825,7 @@ "label": "args", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "TimeRange" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, @@ -35000,13 +34928,7 @@ " | ", "Query", "[] | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", @@ -35303,13 +35225,7 @@ " | ", "Query", "[] | undefined; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 5f0239c3ee434..badce42c47a6f 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3372 | 35 | 2518 | 21 | +| 3072 | 34 | 2399 | 22 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 6f2cdb2350507..6ff647d20d447 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 692d50ae66a77..ce0cac3a3ace3 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index b2dff4fcae8ef..8a0db6bb2066e 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index c0d5b039e6bcd..459b3dcde752b 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -11025,9 +11025,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index ccf8f12cb276c..8d2ffe07ca1e9 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 0de7c1db684e6..4761b678c4b82 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index f5fddc4eb32e1..5683d95bd30fe 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -28,32 +28,32 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | dataViews, maps | - | | | dataViews, maps | - | | | maps | - | -| | management, spaces, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery | - | -| | actions, ml, enterpriseSearch, savedObjectsTagging | - | +| | unifiedSearch | - | +| | unifiedSearch | - | +| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | +| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | +| | visTypeTimeseries, graph, dataViewManagement | - | +| | visTypeTimeseries | - | | | canvas, visTypeXy | - | -| | canvas | - | -| | canvas | - | -| | canvas | - | | | canvas, visTypeXy | - | | | canvas, visTypeXy | - | -| | canvas | - | -| | canvas | - | -| | canvas | - | | | canvas, visTypeXy | - | -| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | -| | visTypeTimeseries, graph, dataViewManagement, dataViews | - | -| | visTypeTimeseries | - | -| | visTypeTimeseries, graph, dataViewManagement | - | -| | unifiedSearch | - | -| | unifiedSearch | - | | | dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | | | dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | | | dataViewManagement | - | | | dataViewManagement | - | +| | canvas | - | +| | canvas | - | +| | canvas | - | +| | canvas | - | +| | canvas | - | +| | canvas | - | +| | management, spaces, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery | - | | | management, cloudSecurityPosture, enterpriseSearch | - | | | enterpriseSearch | - | +| | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | spaces, savedObjectsManagement | - | | | spaces, savedObjectsManagement | - | | | visTypeGauge | - | @@ -62,13 +62,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | console | - | | | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | | | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | -| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | -| | discover, dashboard, lens, urlDrilldown | 8.1 | -| | discover, dashboard, lens, urlDrilldown | 8.1 | -| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | -| | infra, discover, visualizations, dashboard, controls, uiActionsEnhanced, lens, maps, dataVisualizer, ml, fleet, canvas, dashboardEnhanced, discoverEnhanced, monitoring, securitySolution, urlDrilldown, visDefaultEditor, visTypeTimelion, visTypeTimeseries, visTypeVega, cases | 8.1 | -| | discover, dashboard, lens, urlDrilldown | 8.1 | -| | apm | 8.1 | | | spaces, security, alerting | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | | | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | @@ -79,13 +72,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | savedObjectsTaggingOss, visualizations, dashboard, lens | 8.8.0 | | | dashboard | 8.8.0 | | | dashboard, maps | 8.8.0 | +| | monitoring, kibanaUsageCollection | 8.8.0 | +| | cloud, apm | 8.8.0 | | | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | +| | management, fleet, security, kibanaOverview | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | -| | management, fleet, security, kibanaOverview | 8.8.0 | -| | monitoring, kibanaUsageCollection | 8.8.0 | -| | cloud, apm | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | | | ml | 8.8.0 @@ -110,66 +103,9 @@ Safe to remove. | ---------------|------------| | | data | | | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | -| | data | | | data | | | data | | | data | -| | data | -| | data | | | expressions | | | expressions | | | expressions | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 85c1f61e6d944..75ca037c25bb2 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -47,7 +47,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | 8.8.0 | | | [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks) | - | | | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | @@ -60,9 +59,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | -| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | -| | [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [embeddables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/embeddables.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [build_embeddable_filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/lib/build_embeddable_filters.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [saved_lens.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/saved_lens.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange), [timelion.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/timelion.ts#:~:text=TimeRange) | 8.1 | | | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | @@ -77,16 +73,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## cases - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | -| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | -| | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | - - - ## cloud | Deprecated API | Reference location(s) | Remove By | @@ -115,16 +101,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## controls - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | -| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | -| | [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [options_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/public/services/kibana/options_list.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/controls/common/control_types/options_list/types.ts#:~:text=TimeRange) | 8.1 | - - - ## crossClusterReplication | Deprecated API | Reference location(s) | Remove By | @@ -137,14 +113,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | | | [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl) | - | | | [export_csv_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/export_csv_action.tsx#:~:text=fieldFormats) | - | -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 5 more | 8.1 | -| | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | | [kibana_react.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/kibana_react.ts#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton) | - | | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | @@ -154,16 +124,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## dashboardEnhanced - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | -| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | -| | [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange), [embeddable_to_dashboard_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/embeddable_to_dashboard_drilldown/embeddable_to_dashboard_drilldown.tsx#:~:text=TimeRange) | 8.1 | - - - ## data | Deprecated API | Reference location(s) | Remove By | @@ -205,30 +165,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## dataVisualizer - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | -| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | -| | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange) | 8.1 | - - - ## discover | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | -| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | | | [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl), [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl) | - | | | [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=indexPatterns) | - | -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | -| | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 2 more | 8.1 | -| | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - | | | [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - | @@ -236,16 +180,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## discoverEnhanced - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | -| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | -| | [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange), [explore_data_context_menu_action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#:~:text=TimeRange) | 8.1 | - - - ## embeddable | Deprecated API | Reference location(s) | Remove By | @@ -294,9 +228,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | -| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | -| | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | | | [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/integrations/app.tsx#:~:text=RedirectAppLinks)+ 5 more | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | @@ -339,10 +270,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | | | [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns) | - | -| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | -| | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | @@ -377,14 +305,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange) | 8.1 | | | [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=syncQueryStateWithUrl), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=syncQueryStateWithUrl) | - | | | [ranges.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#:~:text=fieldFormats), [droppable.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts#:~:text=fieldFormats) | - | -| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | -| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | -| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange) | 8.1 | -| | [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange), [time_scale.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts#:~:text=TimeRange) | 8.1 | -| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | | | [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -422,13 +344,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl), [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl) | - | | | [kibana_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/kibana_services.ts#:~:text=indexPatterns) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -448,9 +367,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | -| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | -| | [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [anomaly_explorer_charts_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/navigation_menu/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange), [date_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/common/util/date_utils.ts#:~:text=TimeRange)+ 4 more | 8.1 | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate) | - | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - | | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -469,10 +385,7 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl) | - | -| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | -| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | @@ -601,14 +514,11 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | -| | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 5 more | 8.8.0 | -| | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 5 more | 8.8.0 | +| | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | +| | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | 8.8.0 | @@ -663,16 +573,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## uiActionsEnhanced - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | -| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | -| | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 5 more | 8.1 | - - - ## unifiedSearch | Deprecated API | Reference location(s) | Remove By | @@ -692,19 +592,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## urlDrilldown - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=TimeRange) | 8.1 | -| | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | - - - ## ux | Deprecated API | Reference location(s) | Remove By | @@ -713,16 +600,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## visDefaultEditor - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | -| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | -| | [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [agg_group.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/agg_group.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [data_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/data_tab.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange), [sidebar.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx#:~:text=TimeRange) | 8.1 | - - - ## visTypeGauge | Deprecated API | Reference location(s) | Remove By | @@ -748,41 +625,18 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## visTypeTimelion - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | -| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | -| | [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/timelion_vis_fn.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange), [timelion_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timelion/public/helpers/timelion_request_handler.ts#:~:text=TimeRange) | 8.1 | - - - ## visTypeTimeseries | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/plugin.ts#:~:text=fieldFormats) | - | -| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields), [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | -| | [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange), [vis_editor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/components/vis_editor.tsx#:~:text=TimeRange) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/plugin.ts#:~:text=fieldFormats) | - | | | [abstract_search_strategy.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts#:~:text=getNonScriptedFields), [fetch_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/timeseries/public/application/lib/fetch_fields.ts#:~:text=getNonScriptedFields) | - | -## visTypeVega - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | -| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | -| | [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_fn.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [vega_request_handler.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/vega_request_handler.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange), [time_cache.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/time_cache.ts#:~:text=TimeRange) | 8.1 | - - - ## visTypeVislib | Deprecated API | Reference location(s) | Remove By | @@ -807,10 +661,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | | | [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl) | - | -| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | -| | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange) | 8.1 | | | [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 4e41da90b698a..38244e76f344c 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -13,7 +13,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| apm | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery) | 8.1 | | apm | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | 8.8.0 | | apm | | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | apm | | [license_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/context/license/license_context.tsx#:~:text=license%24) | 8.8.0 | @@ -25,12 +24,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | -| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | -| uiActionsEnhanced | | [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [customize_time_range_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/customize_time_range_modal.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_action.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [custom_time_range_badge.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/custom_time_range_badge.tsx#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [can_inherit_time_range.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/can_inherit_time_range.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange), [time_range_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/ui_actions_enhanced/public/test_helpers/time_range_embeddable.ts#:~:text=TimeRange)+ 13 more | 8.1 | -| urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | -| urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | -| urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | embeddable | | [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | @@ -39,12 +32,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | -| discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | -| discover | | [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/locator.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/types.ts#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/layout/types.ts#:~:text=TimeRange)+ 4 more | 8.1 | -| discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | graph | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -54,9 +41,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | -| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | -| fleet | | [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange), [agent_logs.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=TimeRange) | 8.1 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | @@ -68,9 +52,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| maps | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | -| maps | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | -| maps | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/reducers/map/types.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/selectors/map_selectors.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [map_actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/actions/map_actions.ts#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [vector_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/saved_map/types.ts#:~:text=TimeRange)+ 36 more | 8.1 | | maps | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | maps | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | | mapsEms | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | @@ -94,12 +75,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | --------|-------|-----------|-----------| | inputControlVis | | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 | | inputControlVis | | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [convert_dashboard_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/convert_dashboard_state.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=TimeRange), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#:~:text=TimeRange)+ 20 more | 8.1 | -| dashboard | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | dashboard | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | dashboard | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | | dashboard | | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | @@ -116,16 +91,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## Logs and Metrics UI - -| Plugin | Deprecated API | Reference location(s) | Remove By | -| --------|-------|-----------|-----------| -| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | -| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | -| infra | | [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [use_kibana_timefilter_time.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_timefilter_time.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [log_stream_embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/components/log_stream/log_stream_embeddable.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange), [use_log_entry_rate_results_url_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/log_entry_rate/use_log_entry_rate_results_url_state.tsx#:~:text=TimeRange)+ 1 more | 8.1 | - - - ## Logstash | Plugin | Deprecated API | Reference location(s) | Remove By | @@ -138,9 +103,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | -| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | -| dataVisualizer | | [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [results_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [date_picker_wrapper.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/common/components/date_picker_wrapper/date_picker_wrapper.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [search_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/locator/locator.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange), [anomaly_timeline_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts#:~:text=TimeRange)+ 12 more | 8.1 | | ml | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | | ml | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | | ml | | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -188,27 +150,14 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## ResponseOps - -| Plugin | Deprecated API | Reference location(s) | Remove By | -| --------|-------|-----------|-----------| -| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | -| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | -| cases | | [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [serializer.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/lens/serializer.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cases/common/utils/markdown_plugins/utils.ts#:~:text=TimeRange) | 8.1 | - - - ## Security solution | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| | securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | -| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | -| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | | securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | -| securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx#:~:text=TimeRange) | 8.1 | -| securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 5 more | 8.8.0 | -| securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 5 more | 8.8.0 | +| securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | +| securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | | securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | | securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/index.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler)+ 3 more | 8.8.0 | @@ -227,9 +176,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | -| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | -| monitoring | | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange), [global_state_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/application/contexts/global_state_context.tsx#:~:text=TimeRange) | 8.1 | | monitoring | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | @@ -238,12 +184,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 27 more | 8.1 | -| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 27 more | 8.1 | -| visualizations | | [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/types.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [locator.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/common/locator.ts#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange), [embeddable.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/embeddable/embeddable.tsx#:~:text=TimeRange)+ 27 more | 8.1 | | visualizations | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | visualizations | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | -| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | -| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | -| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | | management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 4dea92a222265..bca811b137130 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 6740276120bc4..738d6255dc1fd 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 6584490e7c347..afd26d8f4c263 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index ec575d551a733..bf80df96fbcc5 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index a6737f6650638..ae626a79b9444 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index c8873882cc3a3..7a04080e707ce 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 319b3b5198e43..f80624d76f739 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index b218b8f933f54..89c9d98c5a85b 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 3ad01719d1506..71748ba2c183e 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 3ca4853bd2823..5c7f4d4392176 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 42f392650f117..c0f5673c3e4a5 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 71115486d3599..972a3099e2ee5 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index ff3eb921466cc..c738384c60305 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 0f275e9b6c018..aa27f9360b628 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index b8c422da05f27..452d5166377c2 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 46b37e71cbf25..ceb63f6fdc9d5 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index b4e4ef9bf5cf6..be5ffab9f5e45 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index b4bddb1883e5b..5260a7add6010 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index e5bf549f9d90e..51bd5c3790838 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index 1ff5125f23082..7e9db0b0f0c70 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index fc8c1da0baa60..cf4f2a7ae3ebb 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index efc368456ed80..4f8f87e51555d 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index a54e704f338e7..bc48042555b6f 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index f1ad873b5f766..f7888f42d35ed 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -240,6 +240,21 @@ "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.Execution.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/execution/execution.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -965,7 +980,9 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", + " = Record>(logger?: ", + "Logger", + " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", @@ -991,6 +1008,21 @@ "id": "def-public.Executor.createWithDefaults.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.Executor.createWithDefaults.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -1098,26 +1130,6 @@ "deprecated": true, "references": [] }, - { - "parentPluginId": "expressions", - "id": "def-public.Executor.parent", - "type": "Object", - "tags": [], - "label": "parent", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - " | undefined" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false - }, { "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed", @@ -1136,6 +1148,21 @@ "id": "def-public.Executor.Unnamed.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.Executor.Unnamed.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -1918,29 +1945,6 @@ } ], "returnComment": [] - }, - { - "parentPluginId": "expressions", - "id": "def-public.Executor.fork", - "type": "Function", - "tags": [], - "label": "fork", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false, - "children": [], - "returnComment": [] } ], "initialIsOpen": false @@ -3975,7 +3979,7 @@ "id": "def-public.ExpressionsService.Unnamed.$1", "type": "Object", "tags": [], - "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", + "label": "{\n logger,\n executor = Executor.createWithDefaults(logger),\n renderers = new ExpressionRendererRegistry(),\n }", "description": [], "signature": [ { @@ -12673,6 +12677,21 @@ "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-server.Execution.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/execution/execution.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -13189,7 +13208,9 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", + " = Record>(logger?: ", + "Logger", + " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", @@ -13215,6 +13236,21 @@ "id": "def-server.Executor.createWithDefaults.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.Executor.createWithDefaults.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -13322,26 +13358,6 @@ "deprecated": true, "references": [] }, - { - "parentPluginId": "expressions", - "id": "def-server.Executor.parent", - "type": "Object", - "tags": [], - "label": "parent", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - " | undefined" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false - }, { "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed", @@ -13360,6 +13376,21 @@ "id": "def-server.Executor.Unnamed.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.Executor.Unnamed.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -14142,29 +14173,6 @@ } ], "returnComment": [] - }, - { - "parentPluginId": "expressions", - "id": "def-server.Executor.fork", - "type": "Function", - "tags": [], - "label": "fork", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false, - "children": [], - "returnComment": [] } ], "initialIsOpen": false @@ -15388,7 +15396,7 @@ "id": "def-server.ExpressionsServerPlugin.Unnamed.$1", "type": "Object", "tags": [], - "label": "initializerContext", + "label": "context", "description": [], "signature": [ { @@ -21047,6 +21055,21 @@ "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-common.Execution.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/execution/execution.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -21772,7 +21795,9 @@ "label": "createWithDefaults", "description": [], "signature": [ - " = Record>(state?: ", + " = Record>(logger?: ", + "Logger", + " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", @@ -21798,6 +21823,21 @@ "id": "def-common.Executor.createWithDefaults.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.Executor.createWithDefaults.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -21905,26 +21945,6 @@ "deprecated": true, "references": [] }, - { - "parentPluginId": "expressions", - "id": "def-common.Executor.parent", - "type": "Object", - "tags": [], - "label": "parent", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - " | undefined" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false - }, { "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed", @@ -21943,6 +21963,21 @@ "id": "def-common.Executor.Unnamed.$1", "type": "Object", "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/executor/executor.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.Executor.Unnamed.$2", + "type": "Object", + "tags": [], "label": "state", "description": [], "signature": [ @@ -22725,29 +22760,6 @@ } ], "returnComment": [] - }, - { - "parentPluginId": "expressions", - "id": "def-common.Executor.fork", - "type": "Function", - "tags": [], - "label": "fork", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" - ], - "path": "src/plugins/expressions/common/executor/executor.ts", - "deprecated": false, - "children": [], - "returnComment": [] } ], "initialIsOpen": false @@ -24094,7 +24106,7 @@ "id": "def-common.ExpressionsService.Unnamed.$1", "type": "Object", "tags": [], - "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", + "label": "{\n logger,\n executor = Executor.createWithDefaults(logger),\n renderers = new ExpressionRendererRegistry(),\n }", "description": [], "signature": [ { @@ -30942,6 +30954,20 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionServiceParams.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.renderers", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 702747e6b7379..7ceb36224bb14 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2176 | 17 | 1722 | 5 | +| 2180 | 17 | 1726 | 5 | ## Client diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 0ea745c09724b..f66bc3d55d9a3 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index de50b4c79027f..5021dd2eea449 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index c08489d474686..729b43555dc75 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index e3c431e3335f8..f060abd995232 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -2729,6 +2729,21 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.debug", + "type": "Function", + "tags": [], + "label": "debug", + "description": [], + "signature": [ + "() => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -11138,7 +11153,7 @@ "label": "body", "description": [], "signature": [ - "{ packagePolicyIds: string[]; }" + "{ packagePolicyIds: string[]; force?: boolean | undefined; }" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false @@ -20804,6 +20819,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.LICENSE_FOR_SCHEDULE_UPGRADE", + "type": "string", + "tags": [], + "label": "LICENSE_FOR_SCHEDULE_UPGRADE", + "description": [], + "signature": [ + "\"platinum\"" + ], + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG", @@ -22392,6 +22421,51 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath", + "type": "Function", + "tags": [], + "label": "getResetOnePreconfiguredAgentPolicyPath", + "description": [], + "signature": [ + "(agentPolicyId: string) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath.$1", + "type": "string", + "tags": [], + "label": "agentPolicyId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getResetAllPreconfiguredAgentPolicyPath", + "type": "Function", + "tags": [], + "label": "getResetAllPreconfiguredAgentPolicyPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -22797,6 +22871,16 @@ "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false, "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.APP_API_ROUTES.HEALTH_CHECK_PATTERN", + "type": "string", + "tags": [], + "label": "HEALTH_CHECK_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, { "parentPluginId": "fleet", "id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN", @@ -24084,6 +24168,16 @@ "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PACKAGE_POLICY_API_ROUTES.ORPHANED_INTEGRATION_POLICIES", + "type": "string", + "tags": [], + "label": "ORPHANED_INTEGRATION_POLICIES", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false } ], "initialIsOpen": false @@ -24232,6 +24326,21 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.packagePolicyRouteService.getOrphanedIntegrationPoliciesPath", + "type": "Function", + "tags": [], + "label": "getOrphanedIntegrationPoliciesPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 71008fbb011f1..3bb51cbf90196 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1427 | 8 | 1300 | 10 | +| 1435 | 8 | 1308 | 10 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index b6ace962da867..2f2009cdb8a90 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.mdx b/api_docs/home.mdx index cb4efc7394ae2..bc34d629ae8ac 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 0abd7dafe1dfc..1f34605863969 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 237e1d188a1eb..29f9caea1d449 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 2af55a03958b9..fb3cb5242d85c 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 47fb922cea12a..95f83c9fa5bc1 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index e71b5ee9c4570..7edb48d5d7919 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 85fb794b3cc01..f78923593d2ec 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 8161553290b5a..c44c318c2ff69 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 64b400887b5f1..8226fde3fee3a 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index d94411838ac93..f44200ef97bfe 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 076fb0b37b285..84315fff01c2c 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index f43a920340a8a..47602a63dcc83 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 2c2d370c55530..e061874d47be4 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 0313b6a4bc96c..4fe9239d5d670 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 7de051d50bd1d..72814b9f92bea 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index d616defe56978..e0ebf664398e4 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index d7eefb5218955..fe2c5f5459cfb 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index 995e5e5902dca..c155bf54291d8 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index d70c566be14ef..4fbac5adf9133 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index 2415099300f2a..82ceb55e52a60 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 4f87c899a1c89..319f32b8fcb66 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_performance_metrics.devdocs.json b/api_docs/kbn_ci_stats_performance_metrics.devdocs.json new file mode 100644 index 0000000000000..87ed9278a28f4 --- /dev/null +++ b/api_docs/kbn_ci_stats_performance_metrics.devdocs.json @@ -0,0 +1,75 @@ +{ + "id": "@kbn/ci-stats-performance-metrics", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/ci-stats-performance-metrics", + "id": "def-server.reporter", + "type": "Function", + "tags": [], + "label": "reporter", + "description": [], + "signature": [ + "(options: ReporterOptions) => Promise" + ], + "path": "packages/kbn-ci-stats-performance-metrics/src/reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-performance-metrics", + "id": "def-server.reporter.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "ReporterOptions" + ], + "path": "packages/kbn-ci-stats-performance-metrics/src/reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-performance-metrics", + "id": "def-server.runCli", + "type": "Function", + "tags": [], + "label": "runCli", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-ci-stats-performance-metrics/src/cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx new file mode 100644 index 0000000000000..7c492a4f3179f --- /dev/null +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCiStatsPerformanceMetricsPluginApi +slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics +title: "@kbn/ci-stats-performance-metrics" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/ci-stats-performance-metrics plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_ci_stats_reporter.devdocs.json b/api_docs/kbn_ci_stats_reporter.devdocs.json index 7c0232b6d81dd..195e8e8a5a429 100644 --- a/api_docs/kbn_ci_stats_reporter.devdocs.json +++ b/api_docs/kbn_ci_stats_reporter.devdocs.json @@ -309,6 +309,38 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.reportPerformanceMetrics", + "type": "Function", + "tags": [], + "label": "reportPerformanceMetrics", + "description": [], + "signature": [ + "(metrics: ", + "PerformanceMetrics", + ") => Promise" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.reportPerformanceMetrics.$1", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [], + "signature": [ + "PerformanceMetrics" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index a252ee5af2af1..8bfd1bacb1ebc 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 60 | 0 | 15 | 0 | +| 62 | 0 | 17 | 1 | ## Server diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index a08c2708487a1..d14d05cb69613 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index ec54a8a98a21b..1c1853a813f82 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 152e372f9838e..de9304b37fa96 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 43254c641247c..43479e7f25abb 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index aac83c2bb4ae5..dd452f8e7f0ba 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index b4a987b6c9c8a..34ca1ad7c523a 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 3014690067bf7..415c5c8dbef4e 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index ac90c830633e2..06a3419da43d1 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server.devdocs.json b/api_docs/kbn_core_analytics_server.devdocs.json new file mode 100644 index 0000000000000..d2f49935b878d --- /dev/null +++ b/api_docs/kbn_core_analytics_server.devdocs.json @@ -0,0 +1,114 @@ +{ + "id": "@kbn/core-analytics-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-analytics-server", + "id": "def-server.AnalyticsServicePreboot", + "type": "Type", + "tags": [], + "label": "AnalyticsServicePreboot", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}" + ], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" + ], + "path": "packages/core/analytics/core-analytics-server/src/contracts.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-analytics-server", + "id": "def-server.AnalyticsServiceSetup", + "type": "Type", + "tags": [], + "label": "AnalyticsServiceSetup", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" + ], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" + ], + "path": "packages/core/analytics/core-analytics-server/src/contracts.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-analytics-server", + "id": "def-server.AnalyticsServiceStart", + "type": "Type", + "tags": [], + "label": "AnalyticsServiceStart", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" + ], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; }" + ], + "path": "packages/core/analytics/core-analytics-server/src/contracts.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx new file mode 100644 index 0000000000000..453ba67379d04 --- /dev/null +++ b/api_docs/kbn_core_analytics_server.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreAnalyticsServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-analytics-server +title: "@kbn/core-analytics-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-analytics-server plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 0 | 0 | + +## Server + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_analytics_server_internal.devdocs.json b/api_docs/kbn_core_analytics_server_internal.devdocs.json new file mode 100644 index 0000000000000..fda46f67f4a16 --- /dev/null +++ b/api_docs/kbn_core_analytics_server_internal.devdocs.json @@ -0,0 +1,134 @@ +{ + "id": "@kbn/core-analytics-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService", + "type": "Class", + "tags": [], + "label": "AnalyticsService", + "description": [], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + "CoreContext" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.preboot", + "type": "Function", + "tags": [], + "label": "preboot", + "description": [], + "signature": [ + "() => ", + "AnalyticsServicePreboot" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "() => ", + "AnalyticsServiceSetup" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "() => ", + "AnalyticsServiceStart" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-internal", + "id": "def-server.AnalyticsService.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx new file mode 100644 index 0000000000000..b033e3316a624 --- /dev/null +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreAnalyticsServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal +title: "@kbn/core-analytics-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-analytics-server-internal plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 7 | 0 | 7 | 0 | + +## Server + +### Classes + + diff --git a/api_docs/kbn_core_analytics_server_mocks.devdocs.json b/api_docs/kbn_core_analytics_server_mocks.devdocs.json new file mode 100644 index 0000000000000..6d6fe2b36e0e5 --- /dev/null +++ b/api_docs/kbn_core_analytics_server_mocks.devdocs.json @@ -0,0 +1,107 @@ +{ + "id": "@kbn/core-analytics-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-analytics-server-mocks", + "id": "def-server.analyticsServiceMock", + "type": "Object", + "tags": [], + "label": "analyticsServiceMock", + "description": [], + "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-analytics-server-mocks", + "id": "def-server.analyticsServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-mocks", + "id": "def-server.analyticsServiceMock.createAnalyticsServicePreboot", + "type": "Function", + "tags": [], + "label": "createAnalyticsServicePreboot", + "description": [], + "signature": [ + "() => jest.Mocked<", + "AnalyticsServicePreboot", + ">" + ], + "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-mocks", + "id": "def-server.analyticsServiceMock.createAnalyticsServiceSetup", + "type": "Function", + "tags": [], + "label": "createAnalyticsServiceSetup", + "description": [], + "signature": [ + "() => jest.Mocked<", + "AnalyticsServiceSetup", + ">" + ], + "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-analytics-server-mocks", + "id": "def-server.analyticsServiceMock.createAnalyticsServiceStart", + "type": "Function", + "tags": [], + "label": "createAnalyticsServiceStart", + "description": [], + "signature": [ + "() => jest.Mocked<", + "AnalyticsServiceStart", + ">" + ], + "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx new file mode 100644 index 0000000000000..8df7dd430ee41 --- /dev/null +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreAnalyticsServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks +title: "@kbn/core-analytics-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-analytics-server-mocks plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreAnalyticsServerMocksObj from './kbn_core_analytics_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 5 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index ced92a3a32d9a..1d672c961f10d 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-browser-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index 7a8ef3b91471a..e5e75b54734ce 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-common plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_internal.devdocs.json b/api_docs/kbn_core_base_server_internal.devdocs.json new file mode 100644 index 0000000000000..6cc5a5d30adc9 --- /dev/null +++ b/api_docs/kbn_core_base_server_internal.devdocs.json @@ -0,0 +1,123 @@ +{ + "id": "@kbn/core-base-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError", + "type": "Class", + "tags": [], + "label": "CriticalError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-base-server-internal", + "scope": "server", + "docId": "kibKbnCoreBaseServerInternalPluginApi", + "section": "def-server.CriticalError", + "text": "CriticalError" + }, + " extends Error" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError.Unnamed.$2", + "type": "string", + "tags": [], + "label": "code", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError.Unnamed.$3", + "type": "number", + "tags": [], + "label": "processExitCode", + "description": [], + "signature": [ + "number" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-base-server-internal", + "id": "def-server.CriticalError.Unnamed.$4", + "type": "Object", + "tags": [], + "label": "cause", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "packages/core/base/core-base-server-internal/src/errors.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx new file mode 100644 index 0000000000000..86cb682ec482e --- /dev/null +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreBaseServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-base-server-internal +title: "@kbn/core-base-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-base-server-internal plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreBaseServerInternalObj from './kbn_core_base_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Server + +### Classes + + diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index a813e133f6627..5a9657f828551 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_config_server_internal.devdocs.json b/api_docs/kbn_core_config_server_internal.devdocs.json new file mode 100644 index 0000000000000..da4e89e53775a --- /dev/null +++ b/api_docs/kbn_core_config_server_internal.devdocs.json @@ -0,0 +1,260 @@ +{ + "id": "@kbn/core-config-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.coreDeprecationProvider", + "type": "Function", + "tags": [], + "label": "coreDeprecationProvider", + "description": [], + "signature": [ + "() => ", + "ConfigDeprecation", + "[]" + ], + "path": "packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.ensureValidConfiguration", + "type": "Function", + "tags": [], + "label": "ensureValidConfiguration", + "description": [], + "signature": [ + "(configService: ", + "ConfigService", + ", params: ", + "ConfigValidateParameters", + " | undefined) => Promise" + ], + "path": "packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.ensureValidConfiguration.$1", + "type": "Object", + "tags": [], + "label": "configService", + "description": [], + "signature": [ + "ConfigService" + ], + "path": "packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.ensureValidConfiguration.$2", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "ConfigValidateParameters", + " | undefined" + ], + "path": "packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor", + "type": "Function", + "tags": [], + "label": "getDeprecationsFor", + "description": [], + "signature": [ + "({ provider, settings, path, }: { provider: ", + "ConfigDeprecationProvider", + "; settings?: Record | undefined; path: string; }) => { messages: string[]; levels: string[]; migrated: Record; }" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor.$1", + "type": "Object", + "tags": [], + "label": "{\n provider,\n settings = {},\n path,\n}", + "description": [], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor.$1.provider", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "(factory: ", + "ConfigDeprecationFactory", + ") => ", + "ConfigDeprecation", + "[]" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor.$1.provider.$1", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "ConfigDeprecationFactory" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor.$1.settings", + "type": "Object", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsFor.$1.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsForGlobalSettings", + "type": "Function", + "tags": [], + "label": "getDeprecationsForGlobalSettings", + "description": [], + "signature": [ + "({ provider, settings, }: { provider: ", + "ConfigDeprecationProvider", + "; settings?: Record | undefined; }) => { messages: string[]; levels: string[]; migrated: Record; }" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsForGlobalSettings.$1", + "type": "Object", + "tags": [], + "label": "{\n provider,\n settings = {},\n}", + "description": [], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsForGlobalSettings.$1.provider", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "(factory: ", + "ConfigDeprecationFactory", + ") => ", + "ConfigDeprecation", + "[]" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsForGlobalSettings.$1.provider.$1", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "ConfigDeprecationFactory" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-config-server-internal", + "id": "def-server.getDeprecationsForGlobalSettings.$1.settings", + "type": "Object", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/config/core-config-server-internal/src/test_utils.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx new file mode 100644 index 0000000000000..b6cbf0d678888 --- /dev/null +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreConfigServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-config-server-internal +title: "@kbn/core-config-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-config-server-internal plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreConfigServerInternalObj from './kbn_core_config_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 15 | 0 | 13 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 6d78b0bfac021..619374b571b77 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 8aeffa4b0a86a..4dd6b03d0161c 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 5c4517d534751..b5343541902fb 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index 57edcacd8f414..d9d3756d07cbd 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_i18n_browser.devdocs.json b/api_docs/kbn_core_i18n_browser.devdocs.json new file mode 100644 index 0000000000000..28c1fd36c3064 --- /dev/null +++ b/api_docs/kbn_core_i18n_browser.devdocs.json @@ -0,0 +1,86 @@ +{ + "id": "@kbn/core-i18n-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-i18n-browser", + "id": "def-common.I18nStart", + "type": "Interface", + "tags": [], + "label": "I18nStart", + "description": [ + "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + ], + "path": "packages/core/i18n/core-i18n-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-i18n-browser", + "id": "def-common.I18nStart.Context", + "type": "Function", + "tags": [], + "label": "Context", + "description": [ + "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + ], + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ], + "path": "packages/core/i18n/core-i18n-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-i18n-browser", + "id": "def-common.I18nStart.Context.$1", + "type": "Object", + "tags": [], + "label": "{ children }", + "description": [], + "path": "packages/core/i18n/core-i18n-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-i18n-browser", + "id": "def-common.I18nStart.Context.$1.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "packages/core/i18n/core-i18n-browser/src/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx new file mode 100644 index 0000000000000..fe2b0abb4b4cc --- /dev/null +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreI18nBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-core-i18n-browser +title: "@kbn/core-i18n-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-i18n-browser plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreI18nBrowserObj from './kbn_core_i18n_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 2 | 0 | + +## Common + +### Interfaces + + diff --git a/api_docs/kbn_core_i18n_browser_mocks.devdocs.json b/api_docs/kbn_core_i18n_browser_mocks.devdocs.json new file mode 100644 index 0000000000000..7811c288caed5 --- /dev/null +++ b/api_docs/kbn_core_i18n_browser_mocks.devdocs.json @@ -0,0 +1,73 @@ +{ + "id": "@kbn/core-i18n-browser-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-i18n-browser-mocks", + "id": "def-common.i18nServiceMock", + "type": "Object", + "tags": [], + "label": "i18nServiceMock", + "description": [], + "path": "packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-i18n-browser-mocks", + "id": "def-common.i18nServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-i18n-browser-mocks", + "id": "def-common.i18nServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "I18nStart", + ">" + ], + "path": "packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx new file mode 100644 index 0000000000000..715b38c4aef94 --- /dev/null +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreI18nBrowserMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks +title: "@kbn/core-i18n-browser-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-i18n-browser-mocks plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreI18nBrowserMocksObj from './kbn_core_i18n_browser_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Common + +### Objects + + diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index 96861c44d2bd2..0dfa95e8653ac 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index c39204be565b9..18dd111b5bdea 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index c2664520f5a8c..b7d51a892cad4 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index cc3af53be3195..24787602fd826 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-internal plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index 535d4d3a932b5..596ae2e2d0c87 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 5f379191fe282..73ec2992c6056 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 2162544a05f48..fa6b098cf25ac 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 95f2e776c80e5..05421434cb5b9 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index c3811fd412a2e..3507ad5af0a3f 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index f585bdc573c75..c7fc9e821a93f 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index e30cdaa95acac..ccf27f5dc4907 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 46fa0a53d918f..613bddfbc0e6a 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 1e5f7b4f3af51..80ede3a8f2ce5 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index a593ea5035957..f35f2a788324c 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 08ffcde971221..5425bf061fc86 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 4ff0302d119ec..fea0955a22e95 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index 1a606a88de0cc..e0ccdcdb9b813 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -1070,7 +1070,15 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => ", + " | undefined, { ignoreFilterIfFieldNotInIndex, nestedIgnoreUnmapped }?: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.EsQueryFiltersConfig", + "text": "EsQueryFiltersConfig" + }, + ") => ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1127,14 +1135,18 @@ { "parentPluginId": "@kbn/es-query", "id": "def-common.buildQueryFromFilters.$3", - "type": "boolean", + "type": "Object", "tags": [], - "label": "ignoreFilterIfFieldNotInIndex", - "description": [ - "by default filters that use fields that can't be found in the specified index pattern are not applied. Set this to true if you want to apply them anyway." - ], + "label": "{ ignoreFilterIfFieldNotInIndex = false, nestedIgnoreUnmapped }", + "description": [], "signature": [ - "boolean" + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.EsQueryFiltersConfig", + "text": "EsQueryFiltersConfig" + } ], "path": "packages/kbn-es-query/src/es_query/from_filters.ts", "deprecated": false, @@ -3351,6 +3363,51 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.EsQueryFiltersConfig", + "type": "Interface", + "tags": [], + "label": "EsQueryFiltersConfig", + "description": [ + "\nOptions for building query for filters" + ], + "path": "packages/kbn-es-query/src/es_query/from_filters.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.EsQueryFiltersConfig.ignoreFilterIfFieldNotInIndex", + "type": "CompoundType", + "tags": [], + "label": "ignoreFilterIfFieldNotInIndex", + "description": [ + "\nby default filters that use fields that can't be found in the specified index pattern are not applied. Set this to true if you want to apply them anyway." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-es-query/src/es_query/from_filters.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.EsQueryFiltersConfig.nestedIgnoreUnmapped", + "type": "CompoundType", + "tags": [], + "label": "nestedIgnoreUnmapped", + "description": [ + "\nthe nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error.\nThe optional ignore_unmapped parameter defaults to false.\nThis `nestedIgnoreUnmapped` param allows creating queries with \"ignore_unmapped\": true" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-es-query/src/es_query/from_filters.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.FilterCompareOptions", @@ -3607,6 +3664,21 @@ ], "path": "packages/kbn-es-query/src/kuery/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.KueryQueryOptions.nestedIgnoreUnmapped", + "type": "CompoundType", + "tags": [], + "label": "nestedIgnoreUnmapped", + "description": [ + "\nthe Nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error.\nThe optional ignore_unmapped parameter defaults to false.\nThe `nestedIgnoreUnmapped` param allows creating queries with \"ignore_unmapped\": true" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-es-query/src/kuery/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3891,9 +3963,17 @@ "section": "def-common.KueryQueryOptions", "text": "KueryQueryOptions" }, - " & { allowLeadingWildcards: boolean; queryStringOptions: ", + " & ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.EsQueryFiltersConfig", + "text": "EsQueryFiltersConfig" + }, + " & { allowLeadingWildcards?: boolean | undefined; queryStringOptions?: ", "SerializableRecord", - "; ignoreFilterIfFieldNotInIndex: boolean; }" + " | undefined; }" ], "path": "packages/kbn-es-query/src/es_query/build_es_query.ts", "deprecated": false, diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 63b6540345873..a6869f197252d 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 209 | 1 | 158 | 11 | +| 213 | 1 | 159 | 11 | ## Common diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 5380651f5a379..9bdfd637706b9 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index f7e83c49e3531..fd68af1589767 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index a060876ef8294..9c2f9020578e2 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index f6dc380c6eb57..4c8ed429da1c2 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 2f6eb81c13c6e..321c9000cd1d7 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index ae11aab2ae80e..55782575d4a2d 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 8330b2ec0d1ad..cfc5f243f43d7 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 7b06cbd48ba6a..4e73e2c5ace40 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index d57be8829be1c..ef11b76adc992 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index c6aefbd3a2a73..1380af516f2d0 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index f666a6a35d16d..a3d937b8ee946 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 748ca8964b47e..54487887fbc56 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 116a3e5bfb5a3..b4188f4410c64 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 305bce79f7a17..d031ab2e997bd 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 28f3452aa0801..339350026a676 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index ce97dea91ec10..d6c3951da8a48 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 19a148f1b9a64..73e3151761d74 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 70f66a8d84e60..5be0ada3b19e4 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 06e9bfecbf28b..90e958b824606 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 4d156a34493ca..619141948aebe 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index f96db886af8ee..9030770483370 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index 1e8d2e041ad8c..8ed75da929b79 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 21a881b8c9e94..429c623648380 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index bca0097fd340c..9c72ccef64e2f 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_scalability_simulation_generator.mdx b/api_docs/kbn_scalability_simulation_generator.mdx index 99e0436572c4c..0c9777f519007 100644 --- a/api_docs/kbn_scalability_simulation_generator.mdx +++ b/api_docs/kbn_scalability_simulation_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-scalability-simulation-generator title: "@kbn/scalability-simulation-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/scalability-simulation-generator plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/scalability-simulation-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index befdcbf244df1..6a6308e1ffae9 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.devdocs.json b/api_docs/kbn_securitysolution_es_utils.devdocs.json index 4f614b716c4d1..45c476c002e50 100644 --- a/api_docs/kbn_securitysolution_es_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_es_utils.devdocs.json @@ -582,9 +582,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; Internal: ", "default", @@ -1824,9 +1824,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; Internal: ", "default", diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 14e3623c1d2f1..2ee30c0656dcf 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index a5d22f2856471..dcc8bf31d9049 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index b6dbcd138101b..117a1eb2c5159 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 9b722a3e50c54..9c5752b203eb0 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index c28cef5e556ac..48fd0ca8ed815 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 986209b3533f0..571a2f9303ccb 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index c3df2a70c2ca5..a0bcd043d61d4 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index e7bc1ce950efa..993f080fcc193 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index aaf737e4d5b00..85234c585d286 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index d4ac078abbad4..c8d5be6aad2c5 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index c3075b99ee570..96b51f9113c2e 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 629e39084edf0..789760a4208e4 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index 37ec345bcef94..f07604490c02d 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index e283d62175b26..3b15b68770eda 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index 42035384c3d57..af36112b1cda2 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_button_toolbar.devdocs.json b/api_docs/kbn_shared_ux_button_toolbar.devdocs.json new file mode 100644 index 0000000000000..692a5abd289b6 --- /dev/null +++ b/api_docs/kbn_shared_ux_button_toolbar.devdocs.json @@ -0,0 +1,410 @@ +{ + "id": "@kbn/shared-ux-button-toolbar", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.AddFromLibraryButton", + "type": "Function", + "tags": [], + "label": "AddFromLibraryButton", + "description": [ + "\nA button that acts to add an item from the library to a solution, typically through a modal." + ], + "signature": [ + "({ onClick, ...rest }: ", + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.AddFromLibraryButton.$1", + "type": "Object", + "tags": [], + "label": "{ onClick, ...rest }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButtonGroup", + "type": "Function", + "tags": [], + "label": "IconButtonGroup", + "description": [ + "\nA group of buttons each performing an action, represented by an icon." + ], + "signature": [ + "({ buttons, legend }: ", + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButtonGroup.$1", + "type": "Object", + "tags": [], + "label": "{ buttons, legend }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.PrimaryButton", + "type": "Function", + "tags": [], + "label": "PrimaryButton", + "description": [ + "\nA primary action button, usually appearing first in the toolbar." + ], + "signature": [ + "({ label, iconSide, ...rest }: ", + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.PrimaryButton.$1", + "type": "Object", + "tags": [], + "label": "{ label, iconSide = 'left', ...rest }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.ToolbarPopover", + "type": "Function", + "tags": [], + "label": "ToolbarPopover", + "description": [ + "\nA button which opens a popover of additional actions within the toolbar." + ], + "signature": [ + "({ label, iconType, children, iconSide, ...popover }: ", + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/shared-ux/button_toolbar/src/popover/popover.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.ToolbarPopover.$1", + "type": "CompoundType", + "tags": [], + "label": "{ label, iconType, children, iconSide, ...popover }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/shared-ux/button_toolbar/src/popover/popover.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButton", + "type": "Interface", + "tags": [], + "label": "IconButton", + "description": [ + "\nAn interface representing a single icon button in the `IconButtonGroup`." + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButton.label", + "type": "string", + "tags": [], + "label": "label", + "description": [ + "The accessible button label." + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButton.iconType", + "type": "CompoundType", + "tags": [], + "label": "iconType", + "description": [ + "EUI `IconType` to display." + ], + "signature": [ + "string | React.ComponentType<{}>" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButton.onClick", + "type": "Function", + "tags": [], + "label": "onClick", + "description": [ + "Handler for button click." + ], + "signature": [ + "() => void" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.IconButton.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "HTML `title` attribute for tooltips if different from `label`" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props", + "type": "Interface", + "tags": [], + "label": "Props", + "description": [ + "\nProps for `IconButtonGroup`." + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props.legend", + "type": "string", + "tags": [], + "label": "legend", + "description": [ + "Required accessible legend for the whole group" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props.buttons", + "type": "Array", + "tags": [], + "label": "buttons", + "description": [ + "Array of `IconButton`" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.IconButton", + "text": "IconButton" + }, + "[]" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props", + "type": "Interface", + "tags": [], + "label": "Props", + "description": [ + "\nProps for `PrimaryButton`." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-button-toolbar", + "scope": "common", + "docId": "kibKbnSharedUxButtonToolbarPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + " extends Pick<", + "EuiButtonPropsForButton", + ", \"onClick\" | \"iconType\" | \"iconSide\">" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "path": "packages/shared-ux/button_toolbar/src/buttons/primary/primary.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props", + "type": "Type", + "tags": [], + "label": "Props", + "description": [], + "signature": [ + "{ onClick?: React.MouseEventHandler | undefined; iconSide?: ", + "ButtonContentIconSide", + " | undefined; }" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/add_from_library/add_from_library.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props", + "type": "Type", + "tags": [], + "label": "Props", + "description": [ + "\nProps for `ToolbarPopover`." + ], + "signature": [ + "AllowedButtonProps & AllowedPopoverProps & { children: (arg: { closePopover: () => void; }) => React.ReactNode; }" + ], + "path": "packages/shared-ux/button_toolbar/src/popover/popover.tsx", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx new file mode 100644 index 0000000000000..f6f742628e522 --- /dev/null +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnSharedUxButtonToolbarPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar +title: "@kbn/shared-ux-button-toolbar" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-button-toolbar plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 20 | 0 | 6 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_shared_ux_card_no_data.devdocs.json b/api_docs/kbn_shared_ux_card_no_data.devdocs.json new file mode 100644 index 0000000000000..371081ba2eb8b --- /dev/null +++ b/api_docs/kbn_shared_ux_card_no_data.devdocs.json @@ -0,0 +1,477 @@ +{ + "id": "@kbn/shared-ux-card-no-data", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.getMockServices", + "type": "Function", + "tags": [], + "label": "getMockServices", + "description": [ + "\nReturns the Jest-compatible service abstractions for the `NoDataCard` Provider." + ], + "signature": [ + "(params?: ", + "Params", + " | undefined) => ", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardServices", + "text": "NoDataCardServices" + } + ], + "path": "packages/shared-ux/card/no_data/src/mocks.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.getMockServices.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Params", + " | undefined" + ], + "path": "packages/shared-ux/card/no_data/src/mocks.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.getStoryArgTypes", + "type": "Function", + "tags": [], + "label": "getStoryArgTypes", + "description": [ + "\nReturns the Storybook arguments for `NoDataCard`, for its stories and for\nconsuming component stories." + ], + "signature": [ + "() => { canAccessFleet: { control: string; defaultValue: boolean; }; category: { control: { type: string; }; defaultValue: string; }; title: { control: { type: string; }; defaultValue: string; }; description: { control: { type: string; }; defaultValue: string; }; button: { control: { type: string; }; defaultValue: string; }; }" + ], + "path": "packages/shared-ux/card/no_data/src/mocks.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.getStoryServices", + "type": "Function", + "tags": [], + "label": "getStoryServices", + "description": [ + "\nReturns Storybook-compatible service abstractions for the `NoDataCard` Provider." + ], + "signature": [ + "(params: ", + "Params", + ") => ", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardServices", + "text": "NoDataCardServices" + } + ], + "path": "packages/shared-ux/card/no_data/src/mocks.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.getStoryServices.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Params" + ], + "path": "packages/shared-ux/card/no_data/src/mocks.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCard", + "type": "Function", + "tags": [], + "label": "NoDataCard", + "description": [], + "signature": [ + "({ href: srcHref, category, description, ...props }: ", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/shared-ux/card/no_data/src/no_data_card.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCard.$1", + "type": "Object", + "tags": [], + "label": "{ href: srcHref, category, description, ...props }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/shared-ux/card/no_data/src/no_data_card.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardKibanaProvider", + "type": "Function", + "tags": [], + "label": "NoDataCardKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps dependencies to services." + ], + "signature": [ + "({ children, ...dependencies }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardKibanaDependencies", + "text": "NoDataCardKibanaDependencies" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...dependencies\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardKibanaDependencies", + "text": "NoDataCardKibanaDependencies" + }, + ">" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardProvider", + "type": "Function", + "tags": [], + "label": "NoDataCardProvider", + "description": [ + "\nA Context Provider that provides services to the component and its dependencies." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardServices", + "text": "NoDataCardServices" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-card-no-data", + "scope": "common", + "docId": "kibKbnSharedUxCardNoDataPluginApi", + "section": "def-common.NoDataCardServices", + "text": "NoDataCardServices" + }, + ">" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardKibanaDependencies", + "type": "Type", + "tags": [], + "label": "NoDataCardKibanaDependencies", + "description": [ + "\nAn interface containing a collection of Kibana plugins and services required to\nrender this component as well as its dependencies." + ], + "signature": [ + "KibanaDependencies & ", + "RedirectAppLinksKibanaDependencies" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.NoDataCardServices", + "type": "Type", + "tags": [], + "label": "NoDataCardServices", + "description": [ + "\nServices that are consumed by this component and its dependencies." + ], + "signature": [ + "Services & ", + "RedirectAppLinksServices" + ], + "path": "packages/shared-ux/card/no_data/src/services.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-card-no-data", + "id": "def-common.Props", + "type": "Type", + "tags": [], + "label": "Props", + "description": [], + "signature": [ + "{ children?: React.ReactNode; icon?: React.ReactElement<", + "EuiIconProps", + ", string | React.JSXElementConstructor> | null | undefined; image?: string | React.ReactElement> | undefined; className?: string | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; onChange?: React.FormEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; id?: string | undefined; description?: React.ReactNode; security?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; hidden?: boolean | undefined; lang?: string | undefined; onError?: React.ReactEventHandler | undefined; category?: string | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: boolean | \"true\" | \"false\" | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: boolean | \"true\" | \"false\" | undefined; 'aria-checked'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: boolean | \"true\" | \"false\" | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: boolean | \"true\" | \"false\" | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: boolean | \"true\" | \"false\" | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"true\" | \"false\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: boolean | \"true\" | \"false\" | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiline'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiselectable'?: boolean | \"true\" | \"false\" | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-readonly'?: boolean | \"true\" | \"false\" | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: boolean | \"true\" | \"false\" | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: boolean | \"true\" | \"false\" | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; button?: React.ReactNode; href?: string | undefined; rel?: string | undefined; target?: string | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; footer?: React.ReactNode; hasBorder?: boolean | undefined; textAlign?: CardAlignment | undefined; titleElement?: \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"span\" | undefined; titleSize?: \"s\" | \"xs\" | undefined; betaBadgeProps?: Partial<(", + "CommonProps", + " & ", + "DisambiguateSet", + "<(", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & LabelAsString) | (", + "CommonProps", + " & ", + "DisambiguateSet", + "<(", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & ", + "DisambiguateSet", + "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & LabelAsString) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & ", + "DisambiguateSet", + "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & ", + "DisambiguateSet", + "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & LabelAsString) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & ", + "DisambiguateSet", + "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", + "CommonProps", + " & ", + "DisambiguateSet", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", + "DisambiguateSet", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", + "IconType", + " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", + "ToolTipPositions", + " | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: ", + "BetaBadgeSize", + " | undefined; } & ", + "DisambiguateSet", + " & ", + "DisambiguateSet", + "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; })> | undefined; display?: \"subdued\" | \"primary\" | \"accent\" | \"success\" | \"warning\" | \"danger\" | \"transparent\" | \"plain\" | undefined; selectable?: ", + "EuiCardSelectProps", + " | undefined; }" + ], + "path": "packages/shared-ux/card/no_data/src/no_data_card.tsx", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx new file mode 100644 index 0000000000000..baa5703955597 --- /dev/null +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnSharedUxCardNoDataPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data +title: "@kbn/shared-ux-card-no-data" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-card-no-data plugin +date: 2022-06-23 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxCardNoDataObj from './kbn_shared_ux_card_no_data.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 14 | 0 | 7 | 1 | + +## Common + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/kbn_shared_ux_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json index df8a0de2d0ff6..36b5a90b05801 100644 --- a/api_docs/kbn_shared_ux_components.devdocs.json +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -19,72 +19,6 @@ "common": { "classes": [], "functions": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.AddFromLibraryButton", - "type": "Function", - "tags": [], - "label": "AddFromLibraryButton", - "description": [], - "signature": [ - "({ onClick, ...rest }: ", - "Props", - ") => JSX.Element" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.AddFromLibraryButton.$1", - "type": "Object", - "tags": [], - "label": "{ onClick, ...rest }", - "description": [], - "signature": [ - "Props" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/add_from_library/add_from_library.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.IconButtonGroup", - "type": "Function", - "tags": [], - "label": "IconButtonGroup", - "description": [], - "signature": [ - "({ buttons, legend }: ", - "Props", - ") => JSX.Element" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.IconButtonGroup.$1", - "type": "Object", - "tags": [], - "label": "{ buttons, legend }", - "description": [], - "signature": [ - "Props" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/icon_button_group/icon_button_group.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.KibanaPageTemplate", @@ -213,72 +147,6 @@ ], "returnComment": [], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ToolbarButton", - "type": "Function", - "tags": [], - "label": "ToolbarButton", - "description": [], - "signature": [ - "({ label, iconSide, ...rest }: ", - "Props", - ") => JSX.Element" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ToolbarButton.$1", - "type": "Object", - "tags": [], - "label": "{ label, iconSide = 'left', ...rest }", - "description": [], - "signature": [ - "Props" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/buttons/primary/primary.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ToolbarPopover", - "type": "Function", - "tags": [], - "label": "ToolbarPopover", - "description": [], - "signature": [ - "({ label, iconType, children, iconSide, ...popover }: ", - "Props", - ") => JSX.Element" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ToolbarPopover.$1", - "type": "CompoundType", - "tags": [], - "label": "{ label, iconType, children, iconSide, ...popover }", - "description": [], - "signature": [ - "Props" - ], - "path": "packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false } ], "interfaces": [ @@ -368,7 +236,7 @@ ], "signature": [ "{ [x: string]: ", - "ElasticAgentCardProps", + "NoDataCardProps", "; }" ], "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts", diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index bcc049c525f48..c856e7de45b63 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 21 | 0 | 15 | 3 | +| 13 | 0 | 7 | 1 | ## Common diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json index f4beb653b7af2..83b4b33fcbd5e 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json @@ -188,7 +188,7 @@ "label": "getStoryArgTypes", "description": [], "signature": [ - "() => { canCreateNewDataView: { control: string; defaultValue: boolean; }; dataViewsDocLink: { options: (string | undefined)[]; control: { type: string; }; }; hasESData: { control: string; defaultValue: boolean; }; hasUserDataView: { control: string; defaultValue: boolean; }; kibanaGuideDocLink: { control: string; defaultValue: string; }; }" + "() => { canAccessFleet: { control: string; defaultValue: boolean; }; category: { control: { type: string; }; defaultValue: string; }; title: { control: { type: string; }; defaultValue: string; }; description: { control: { type: string; }; defaultValue: string; }; button: { control: { type: string; }; defaultValue: string; }; canCreateNewDataView: { control: string; defaultValue: boolean; }; dataViewsDocLink: { options: (string | undefined)[]; control: { type: string; }; }; hasESData: { control: string; defaultValue: boolean; }; hasUserDataView: { control: string; defaultValue: boolean; }; kibanaGuideDocLink: { control: string; defaultValue: string; }; }" ], "path": "packages/shared-ux/page/analytics_no_data/src/mocks.ts", "deprecated": false, diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index 480849798cd98..4723ab64fc68e 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.devdocs.json b/api_docs/kbn_shared_ux_page_kibana_no_data.devdocs.json index d427025ca79b9..c8af7fe42f402 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.devdocs.json @@ -72,7 +72,7 @@ "\nReturns the Storybook arguments for `KibanaNoDataPage`, for its stories for and for\nconsuming component stories." ], "signature": [ - "() => { canCreateNewDataView: { control: string; defaultValue: boolean; }; dataViewsDocLink: { options: (string | undefined)[]; control: { type: string; }; }; solution: { control: string; defaultValue: string; }; logo: { control: { type: string; }; options: (string | undefined)[]; defaultValue: undefined; }; hasESData: { control: string; defaultValue: boolean; }; hasUserDataView: { control: string; defaultValue: boolean; }; }" + "() => { canAccessFleet: { control: string; defaultValue: boolean; }; category: { control: { type: string; }; defaultValue: string; }; title: { control: { type: string; }; defaultValue: string; }; description: { control: { type: string; }; defaultValue: string; }; button: { control: { type: string; }; defaultValue: string; }; canCreateNewDataView: { control: string; defaultValue: boolean; }; dataViewsDocLink: { options: (string | undefined)[]; control: { type: string; }; }; solution: { control: string; defaultValue: string; }; logo: { control: { type: string; }; options: (string | undefined)[]; defaultValue: undefined; }; hasESData: { control: string; defaultValue: boolean; }; hasUserDataView: { control: string; defaultValue: boolean; }; }" ], "path": "packages/shared-ux/page/kibana_no_data/src/mocks.ts", "deprecated": false, diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index e47f5b9daf814..214a878423a93 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 255b56f6a9dd8..b7fb30739d2b8 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index 14cd49894a5e7..5f60e287b33d3 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index b405fd2cf9465..eb278f6594d12 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 7decdcc305e7b..3cee3986320d0 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index 7e5e5c6eceb3c..42b1a1ec4b1b1 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 3368a7ab9c159..7807dfb8faf19 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 402b716b6cc1f..dcdbeeba9fa5c 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index bd1a62e3435df..72da8a866e68b 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 5521938204a73..6af8cd22263d4 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.devdocs.json b/api_docs/kbn_test.devdocs.json index b049321dd2e41..5ef0d045fbc3f 100644 --- a/api_docs/kbn_test.devdocs.json +++ b/api_docs/kbn_test.devdocs.json @@ -958,6 +958,87 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.KbnClientRequesterError", + "type": "Class", + "tags": [], + "label": "KbnClientRequesterError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/test", + "scope": "server", + "docId": "kibKbnTestPluginApi", + "section": "def-server.KbnClientRequesterError", + "text": "KbnClientRequesterError" + }, + " extends Error" + ], + "path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/test", + "id": "def-server.KbnClientRequesterError.axiosError", + "type": "Object", + "tags": [], + "label": "axiosError", + "description": [], + "signature": [ + "AxiosError", + " | undefined" + ], + "path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.KbnClientRequesterError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/test", + "id": "def-server.KbnClientRequesterError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.KbnClientRequesterError.Unnamed.$2", + "type": "Unknown", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "unknown" + ], + "path": "packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/test", "id": "def-server.Lifecycle", diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 6f1b84a16cd16..5b96789883cea 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Operations for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 241 | 5 | 202 | 9 | +| 246 | 5 | 207 | 9 | ## Server diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index d782de1dae9f6..8b3b115917f5f 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index b6014d1b8c0eb..d5d72ee68eb46 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index df57d5d260f5f..d9a99bc918996 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index ae6037a1263f3..0d47f81985c33 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index da6173029a84a..6ed9941720d38 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index aa9b3fb0ea96f..afad507cc268f 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 797ab4c9112d8..bd4ac2c281582 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 1a67afdbbd632..ef3e2bead5c0e 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types-jest plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 0f4d4f4b7174a..09a812a5932a1 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index 78ed43bbada8f..6b55b014d810e 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 76bb04637fae1..30705843ab0f9 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -4387,13 +4387,7 @@ "text": "SavedObjectsStart" }, " | undefined; i18n?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.I18nStart", - "text": "I18nStart" - }, + "I18nStart", " | undefined; notifications?: ", { "pluginId": "core", @@ -5194,7 +5188,7 @@ "label": "eui", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 2242d950f6c29..9a57e86eb9534 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index fbd9b5bdd4acf..e7d76168b35b4 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index bef023719b650..3533959bd49bd 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github summary: API docs for the kubernetesSecurity plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index 36811434f6524..706e10de5bdf5 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -8937,13 +8937,7 @@ "description": [], "signature": [ "(id: string | undefined, timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined) => string" ], "path": "x-pack/plugins/lens/common/constants.ts", @@ -8971,13 +8965,7 @@ "label": "timeRange", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, + "TimeRange", " | undefined" ], "path": "x-pack/plugins/lens/common/constants.ts", diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 1f41d750347a1..94aad70595690 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 0311a4144606e..67ab1d0b38048 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index 64d2d74d65595..b9ca3227c0186 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index 45f8a135afef5..3e7f24385561c 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -551,14 +551,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts" @@ -2312,14 +2304,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts" diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 90c723377b5b2..7768b99acd2d8 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.devdocs.json b/api_docs/lists.devdocs.json index c158f3bc048fd..cfca7e62412b5 100644 --- a/api_docs/lists.devdocs.json +++ b/api_docs/lists.devdocs.json @@ -4163,9 +4163,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 374c61201b9aa..0ad5f14873cda 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index ec9cedc1b123d..f32d58cf2a204 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 48aea2c4895dc..c0ba7a0faca21 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 9d4043ad6cc75..9e2359a5d964e 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 1ea342d35e1de..c1df1686a8069 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 748bb78ac66d1..13e932aff2c8c 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 088a3a7cac1d3..1cdd404bf76bf 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index 207c3bb12cf30..165f0f335d986 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 8048f69d979dc..a39288cf3cd8d 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index ba2cf8008a71e..fe47345018d5f 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -5482,9 +5482,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 17c7f3d460722..e2dcae516b104 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index f7e4d6adb8263..f86a267e95cec 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 32383fd0f8d8b..c71faef8e65e0 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 290 | 233 | 35 | +| 300 | 243 | 35 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 26620 | 172 | 19141 | 1252 | +| 26416 | 171 | 19085 | 1248 | ## Plugin Directory @@ -38,12 +38,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2527 | 15 | 940 | 29 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2527 | 15 | 938 | 29 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3372 | 35 | 2518 | 21 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3072 | 34 | 2399 | 22 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 15 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | @@ -71,11 +71,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 7 | 0 | 7 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 148 | 0 | 138 | 14 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2176 | 17 | 1722 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2180 | 17 | 1726 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 288 | 5 | 249 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1427 | 8 | 1300 | 10 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1435 | 8 | 1308 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -163,7 +163,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 379 | 12 | 355 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 380 | 12 | 356 | 14 | | watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | ## Package Directory @@ -186,7 +186,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 18 | 0 | 9 | 1 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 7 | 0 | 2 | 0 | -| | [Owner missing] | - | 60 | 0 | 15 | 0 | +| | [Owner missing] | - | 3 | 0 | 3 | 0 | +| | [Owner missing] | - | 62 | 0 | 17 | 1 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 106 | 0 | 80 | 1 | | | [Owner missing] | - | 73 | 0 | 44 | 1 | @@ -195,13 +196,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 7 | 0 | 7 | 1 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 3 | 0 | 0 | 0 | +| | [Owner missing] | - | 7 | 0 | 7 | 0 | +| | [Owner missing] | - | 5 | 0 | 5 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 12 | 0 | 3 | 0 | +| | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | +| | [Owner missing] | - | 15 | 0 | 13 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 5 | 0 | 2 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 4 | 0 | 2 | 0 | +| | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 8 | 2 | 6 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | | | [Owner missing] | - | 56 | 0 | 30 | 0 | @@ -218,7 +226,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 65 | 0 | 65 | 2 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | -| | [Owner missing] | - | 209 | 1 | 158 | 11 | +| | [Owner missing] | - | 213 | 1 | 159 | 11 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 20 | 0 | 16 | 0 | | | [Owner missing] | - | 2 | 0 | 0 | 0 | @@ -260,7 +268,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 31 | 0 | 29 | 0 | | | [Owner missing] | - | 53 | 0 | 50 | 1 | | | [Owner missing] | - | 25 | 0 | 24 | 1 | -| | [Owner missing] | - | 21 | 0 | 15 | 3 | +| | [Owner missing] | - | 20 | 0 | 6 | 0 | +| | [Owner missing] | - | 14 | 0 | 7 | 1 | +| | [Owner missing] | - | 13 | 0 | 7 | 1 | | | [Owner missing] | - | 12 | 0 | 8 | 5 | | | [Owner missing] | - | 31 | 0 | 12 | 2 | | | [Owner missing] | - | 21 | 0 | 12 | 2 | @@ -272,7 +282,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 4 | 0 | 2 | 0 | | | Operations | - | 38 | 2 | 21 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | -| | Operations | - | 241 | 5 | 202 | 9 | +| | Operations | - | 246 | 5 | 207 | 9 | | | [Owner missing] | - | 135 | 8 | 103 | 2 | | | [Owner missing] | - | 72 | 0 | 55 | 0 | | | [Owner missing] | - | 29 | 0 | 2 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 8d17c70635b98..19052227c3c90 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index a042b3740a67f..3729b362ce583 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index b1c829f78678e..13556c6e80806 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index d10a59bbd07d3..f4fda7540b8a0 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 33f15039f24ae..272a8758c5ab1 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 89138bbe32a3b..fabadde1d3537 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index a61a7eee2ca45..d9fac2851b6d2 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 7b15727ad98e6..79f1d2c7a2b4a 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index e4c11a2821387..38e12b4aed2cf 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 49c58d8bd77f3..400d7bca2e21b 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 61d950b32adfa..97e6cd138ec62 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index 517de3434b0ad..2f4e0440757c1 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 341da1ff265f2..99283269165de 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index c79b7d1ed0fc4..f9c4373d9fb2d 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index c4ea5ee61f820..47a076253b042 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 85d7476dfa0f2..cd8bb647f2b8d 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index 500e70f9d6fac..d73c5303e9b74 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 72118a77eee39..417c2500ed8cc 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index bf0983152c457..af5231f6d3cd3 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 183b1f1105347..4395c11d84e4c 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 1426b95f84d09..b734c5bfc99a0 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 495a173de69f4..b2a40aa42d368 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.devdocs.json b/api_docs/telemetry_collection_manager.devdocs.json index c0bed4f0c9b72..5d7ae451769f4 100644 --- a/api_docs/telemetry_collection_manager.devdocs.json +++ b/api_docs/telemetry_collection_manager.devdocs.json @@ -266,9 +266,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 374f795aa17ff..a277dd510cb85 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index be49b24529e5e..fa058e7406b50 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 21dea3bcd1f30..3e673801c2faf 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 44c529cd368f1..1f32392bafbb5 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index f0407efcf8d13..2789c007d9ebd 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 80428368d4eac..af6efe1d4420a 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 91add4fe3a647..f242a77c877ca 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 3c4dd685e0dfb..d59b3f8d53f0e 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index e8c89e1094e70..d6df7ac389983 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 4b52092837842..c2ea826c491b8 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index c12a378c02365..016ef659b8ba9 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.devdocs.json b/api_docs/usage_collection.devdocs.json index c8e999ebd31a4..15737e2480fdf 100644 --- a/api_docs/usage_collection.devdocs.json +++ b/api_docs/usage_collection.devdocs.json @@ -520,9 +520,9 @@ "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", - ">; }; helpers: ", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "; helpers: ", "default", "; child: (opts: ", "ClientOptions", diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index 5e94564ea7785..de91ebeef3794 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index dd3e748e4f8da..6b85fe44c412e 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index 36ded170d7d2f..d7f1cffbb3585 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index d410523075e93..e874cf81ef824 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index e2e148842026b..724f26293f5e7 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index b38616526e102..1535dda901b09 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index eb93a2b5f1105..eb1432e796dbd 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 42c8cd671ebe2..abebd148d2620 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index c3f505b257520..ef935085bd0e4 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 6adce6d305f4f..fde1cd3bcebd4 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index daf06b80d1df9..e06824be95340 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 6012d5344f67b..b34bd6b4905dd 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 9c5ca75bc9bcc..905974977e35b 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -4513,6 +4513,19 @@ "path": "src/plugins/visualizations/public/vis_types/types.ts", "deprecated": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.VisualizeEditorLayersContext.collapseFn", + "type": "string", + "tags": [], + "label": "collapseFn", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisualizeEditorLayersContext.splitFilters", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index f1fc3dd6e816f..a41c9bd8bbb59 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-06-21 +date: 2022-06-23 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 379 | 12 | 355 | 14 | +| 380 | 12 | 356 | 14 | ## Client diff --git a/dev_docs/key_concepts/data_views.mdx b/dev_docs/key_concepts/data_views.mdx index c514af21c0cf7..6a0c2a701fae2 100644 --- a/dev_docs/key_concepts/data_views.mdx +++ b/dev_docs/key_concepts/data_views.mdx @@ -27,3 +27,10 @@ Users can create data views via [Data view management](https://www.elastic.co/gu Additionally, they can be created through the data view API. Data views also allow formatters and custom labels to be defined for fields. + +### Services + +**hasData:** A standardized way to check the empty state for indices and data views. +- `hasESData: () => Promise; // Check to see if ES data exists` +- `hasDataView: () => Promise; // Check to see if any data view exists (managed or user created)` +- `hasUserDataView: () => Promise; // Check to see if user created data views exists` diff --git a/dev_docs/tutorials/data_views.mdx b/dev_docs/tutorials/data_views.mdx index 76c4bff8e51e3..eda4b34ac2fd4 100644 --- a/dev_docs/tutorials/data_views.mdx +++ b/dev_docs/tutorials/data_views.mdx @@ -84,3 +84,11 @@ await data.indexPatterns.delete(dataViewId); ### Data view HTTP API Rest-like HTTP CRUD+ API - [docs](https://www.elastic.co/guide/en/kibana/master/data-views-api.html) + + +### Services + +#### **hasData:** A standardized way to check the empty state for indices and data views. +- `hasESData: () => Promise; // Check to see if ES data exists` +- `hasDataView: () => Promise; // Check to see if any data view exists (managed or user created)` +- `hasUserDataView: () => Promise; // Check to see if user created data views exists` diff --git a/docs/api/alerting.asciidoc b/docs/api/alerting.asciidoc index fd5a23886cc5a..782b5aaaa77c7 100644 --- a/docs/api/alerting.asciidoc +++ b/docs/api/alerting.asciidoc @@ -33,9 +33,10 @@ For deprecated APIs, refer to <>. include::alerting/create_rule.asciidoc[leveloffset=+1] include::alerting/delete_rule.asciidoc[leveloffset=+1] +include::alerting/find_rules.asciidoc[leveloffset=+1] +include::alerting/health.asciidoc[leveloffset=+1] +include::alerting/get_rules.asciidoc[leveloffset=+1] include::alerting/update_rule.asciidoc[leveloffset=+1] -include::alerting/get_rules.asciidoc[] -include::alerting/find_rules.asciidoc[] include::alerting/list_rule_types.asciidoc[] include::alerting/enable_rule.asciidoc[] include::alerting/disable_rule.asciidoc[] @@ -43,5 +44,4 @@ include::alerting/mute_all_alerts.asciidoc[] include::alerting/mute_alert.asciidoc[] include::alerting/unmute_all_alerts.asciidoc[] include::alerting/unmute_alert.asciidoc[] -include::alerting/health.asciidoc[] include::alerting/legacy/index.asciidoc[] diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc index 0b219ad00ebcb..86538499be010 100644 --- a/docs/api/alerting/create_rule.asciidoc +++ b/docs/api/alerting/create_rule.asciidoc @@ -16,10 +16,11 @@ Create {kib} rules. === {api-prereq-title} -You must have `all` privileges for the *Management* > *Stack Rules* feature or -for the *{ml-app}*, *{observability}*, or *Security* features, depending on the -`consumer` and `rule_type_id` of the rule you're creating. If the rule has -`actions`, you must also have `read` privileges for the *Management* > +You must have `all` privileges for the appropriate {kib} features, depending on +the `consumer` and `rule_type_id` of the rules you're creating. For example, the +*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}* +features, *{observability}*, and *Security* features. If the rule has `actions`, +you must also have `read` privileges for the *Management* > *Actions and Connectors* feature. For more details, refer to <>. diff --git a/docs/api/alerting/delete_rule.asciidoc b/docs/api/alerting/delete_rule.asciidoc index 537b93872059c..12b07c5bb0f12 100644 --- a/docs/api/alerting/delete_rule.asciidoc +++ b/docs/api/alerting/delete_rule.asciidoc @@ -17,9 +17,11 @@ WARNING: After you delete a rule, you cannot recover it. === {api-prereq-title} -You must have `all` privileges for the *Management* > *Stack Rules* feature or -for the *{ml-app}*, *{observability}*, or *Security* features, depending on the -`consumer` and `rule_type_id` of the rule you're deleting. +You must have `all` privileges for the appropriate {kib} features, depending on +the `consumer` and `rule_type_id` of the rule you're deleting. For example, the +*Management* > *Stack Rules* feature, *Analytics* > *Discover* or *{ml-app}* +features, *{observability}*, or *Security* features. For more details, refer to +<>. [[delete-rule-api-path-params]] === {api-path-parms-title} diff --git a/docs/api/alerting/find_rules.asciidoc b/docs/api/alerting/find_rules.asciidoc index 48c4bb25e0eea..13b39db3f280b 100644 --- a/docs/api/alerting/find_rules.asciidoc +++ b/docs/api/alerting/find_rules.asciidoc @@ -1,77 +1,101 @@ [[find-rules-api]] -=== Find rules API +== Find rules API ++++ Find rules ++++ Retrieve a paginated set of rules based on condition. -NOTE: As rules change in {kib}, the results on each page of the response also -change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data. - [[find-rules-api-request]] -==== Request +=== {api-request-title} `GET :/api/alerting/rules/_find` `GET :/s//api/alerting/rules/_find` +=== {api-prereq-title} + +You must have `read` privileges for the appropriate {kib} features, depending on +the `consumer` and `rule_type_id` of the rules you're seeking. For example, the +*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}* +features, *{observability}*, and *Security* features. To find rules associated +with the *{stack-monitor-app}*, use the `monitoring_user` built-in role. + +For more details, refer to <>. + +=== {api-description-title} + +As rules change in {kib}, the results on each page of the response also change. +Use the find API for traditional paginated results, but avoid using it to export +large amounts of data. + +NOTE: Rule `params` are stored as a {ref}/flattened.html[flattened field type] +and analyzed as keywords. + [[find-rules-api-path-params]] -==== Path parameters +=== {api-path-parms-title} `space_id`:: - (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. +(Optional, string) An identifier for the space. If `space_id` is not provided in +the URL, the default space is used. [[find-rules-api-query-params]] -==== Query Parameters +=== {api-query-parms-title} -NOTE: Rule `params` are stored as a {ref}/flattened.html[flattened field type] and analyzed as keywords. +`default_search_operator`:: +(Optional, string) The operator to use for the `simple_query_string`. The +default is 'OR'. -`per_page`:: - (Optional, number) The number of rules to return per page. +`fields`:: +(Optional, array of strings) The fields to return in the `attributes` key of the +response. + +`filter`:: +(Optional, string) A <> string that you filter with an +attribute from your saved object. It should look like +`savedObjectType.attributes.title: "myTitle"`. However, If you used a direct +attribute of a saved object, such as `updatedAt`, you will have to define your +filter, for example, `savedObjectType.updatedAt > 2018-12-22`. + +`has_reference`:: +(Optional, object) Filters the rules that have a relation with the reference +objects with the specific "type" and "ID". `page`:: - (Optional, number) The page number. +(Optional, number) The page number. -`search`:: - (Optional, string) An Elasticsearch {ref}/query-dsl-simple-query-string-query.html[simple_query_string] query that filters the rules in the response. +`per_page`:: +(Optional, number) The number of rules to return per page. -`default_search_operator`:: - (Optional, string) The operator to use for the `simple_query_string`. The default is 'OR'. +`search`:: +(Optional, string) An {es} +{ref}/query-dsl-simple-query-string-query.html[simple_query_string] query that +filters the rules in the response. `search_fields`:: - (Optional, array|string) The fields to perform the `simple_query_string` parsed query against. - -`fields`:: - (Optional, array of strings) The fields to return in the `attributes` key of the response. +(Optional, array or string) The fields to perform the `simple_query_string` +parsed query against. `sort_field`:: - (Optional, string) Sorts the response. Could be a rule field returned in the `attributes` key of the response. +(Optional, string) Sorts the response. Could be a rule field returned in the +`attributes` key of the response. `sort_order`:: - (Optional, string) Sort direction, either `asc` or `desc`. - -`has_reference`:: - (Optional, object) Filters the rules that have a relation with the reference objects with the specific "type" and "ID". - -`filter`:: - (Optional, string) A <> string that you filter with an attribute from your saved object. - It should look like savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object, such as `updatedAt`, - you will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22. +(Optional, string) Sort direction, either `asc` or `desc`. [[find-rules-api-request-codes]] -==== Response code +=== {api-response-codes-title} `200`:: - Indicates a successful call. +Indicates a successful call. -==== Examples +=== {api-examples-title} Find rules with names that start with `my`: [source,sh] -------------------------------------------------- -$ curl -X GET api/alerting/rules/_find?search_fields=name&search=my* +GET api/alerting/rules/_find?search_fields=name&search=my* -------------------------------------------------- // KIBANA @@ -110,18 +134,19 @@ The API returns the following: "scheduled_task_id": "0b092d90-6b62-11eb-9e0d-85d233e3ee35", "execution_status": { "last_execution_date": "2021-02-10T17:55:14.262Z", - "status": "ok" + "status": "ok", + "last_duration": 384 } - }, + } ] } -------------------------------------------------- -For parameters that accept multiple values (e.g. `fields`), repeat the +For parameters that accept multiple values (such as `fields`), repeat the query parameter for each value: [source,sh] -------------------------------------------------- -$ curl -X GET api/alerting/rules/_find?fields=id&fields=name +GET api/alerting/rules/_find?fields=id&fields=name -------------------------------------------------- // KIBANA diff --git a/docs/api/alerting/get_rules.asciidoc b/docs/api/alerting/get_rules.asciidoc index 1594ec1fb7ae6..9c465b9f40ff8 100644 --- a/docs/api/alerting/get_rules.asciidoc +++ b/docs/api/alerting/get_rules.asciidoc @@ -1,5 +1,5 @@ [[get-rule-api]] -=== Get rule API +== Get rule API ++++ Get rule ++++ @@ -7,35 +7,46 @@ Retrieve a rule by ID. [[get-rule-api-request]] -==== Request +=== {api-request-title} `GET :/api/alerting/rule/` `GET :/s//api/alerting/rule/` +=== {api-prereq-title} + +You must have `read` privileges for the appropriate {kib} features, depending on +the `consumer` and `rule_type_id` of the rules you're seeking. For example, the +*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}* +features, *{observability}*, and *Security* features. To get rules associated +with the *{stack-monitor-app}*, use the `monitoring_user` built-in role. + +For more details, refer to <>. + [[get-rule-api-params]] -==== Path parameters +=== {api-path-parms-title} `id`:: - (Required, string) The ID of the rule to retrieve. +(Required, string) The identifier of the rule to retrieve. `space_id`:: - (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. +(Optional, string) An identifier for the space. If `space_id` is not provided in +the URL, the default space is used. [[get-rule-api-codes]] -==== Response code +=== {api-response-codes-title} `200`:: - Indicates a successful call. +Indicates a successful call. [[get-rule-api-example]] -==== Example +=== {api-examples-title} Retrieve the rule object with the ID `41893910-6bca-11eb-9e0d-85d233e3ee35`: [source,sh] -------------------------------------------------- -$ curl -X GET api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35 +GET api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35 -------------------------------------------------- // KIBANA @@ -69,7 +80,8 @@ The API returns the following: "scheduled_task_id": "0b092d90-6b62-11eb-9e0d-85d233e3ee35", "execution_status": { "last_execution_date": "2021-02-10T17:55:14.262Z", - "status": "ok" + "status": "ok", + "last_duration": 359 } } -------------------------------------------------- diff --git a/docs/api/alerting/health.asciidoc b/docs/api/alerting/health.asciidoc index 24955bb81fa98..1f0c8936419b5 100644 --- a/docs/api/alerting/health.asciidoc +++ b/docs/api/alerting/health.asciidoc @@ -1,38 +1,45 @@ [[get-alerting-framework-health-api]] -=== Get Alerting framework health API +== Get alerting framework health API ++++ -Get Alerting framework health +Get alerting framework health ++++ -Retrieve the health status of the Alerting framework. +Retrieve the health status of the alerting framework. [[get-alerting-framework-health-api-request]] -==== Request +=== {api-request-title} `GET :/api/alerting/_health` `GET :/s//api/alerting/_health` +=== {api-prereq-title} + +You must have `read` privileges for the *Management* > *Stack Rules* feature or +for at least one of the *Analytics* > *Discover*, *Analytics* > *{ml-app}*, +*{observability}*, or *Security* features. + [[get-alerting-framework-health-api-params]] -==== Path parameters +=== {api-path-parms-title} `space_id`:: - (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. +(Optional, string) An identifier for the space. If `space_id` is not provided in +the URL, the default space is used. [[get-alerting-framework-health-api-codes]] -==== Response code +=== {api-response-codes-title} `200`:: - Indicates a successful call. +Indicates a successful call. [[get-alerting-framework-health-api-example]] -==== Example +=== {api-examples-title} -Retrieve the health status of the Alerting framework: +Retrieve the health status of the alerting framework: [source,sh] -------------------------------------------------- -$ curl -X GET api/alerting/_health +GET api/alerting/_health -------------------------------------------------- // KIBANA @@ -41,56 +48,46 @@ The API returns the following: [source,sh] -------------------------------------------------- { - "is_sufficiently_secure":true, - "has_permanent_encryption_key":true, - "alerting_framework_health":{ + "is_sufficiently_secure":true, <1> + "has_permanent_encryption_key":true, <2> + "alerting_framework_health":{ <3> "decryption_health":{ "status":"ok", - "timestamp":"2021-02-10T23:35:04.949Z" + "timestamp":"2022-06-21T21:46:15.023Z" + }, + "execution_health":{ + "status":"ok", + "timestamp":"2022-06-21T21:46:15.023Z" + }, + "read_health":{ + "status":"ok", + "timestamp":"2022-06-21T21:46:15.023Z" + } + }, + "alerting_framework_heath":{ <4> + "_deprecated":"This state property has a typo, use \"alerting_framework_health\" instead.","decryption_health":{ + "status":"ok", + "timestamp":"2022-06-21T21:46:15.023Z" }, "execution_health":{ "status":"ok", - "timestamp":"2021-02-10T23:35:04.949Z" + "timestamp":"2022-06-21T21:46:15.023Z" }, "read_health":{ "status":"ok", - "timestamp":"2021-02-10T23:35:04.949Z" + "timestamp":"2022-06-21T21:46:15.023Z" } } } -------------------------------------------------- - -The health API response contains the following properties: - -[cols="2*<"] -|=== - -| `is_sufficiently_secure` -| Returns `false` if security is enabled, but TLS is not. - -| `has_permanent_encryption_key` -| Return the state `false` if Encrypted Saved Object plugin has not a permanent encryption Key. - -| `alerting_framework_health` -| This state property has three substates that identify the health of the alerting framework API: `decryption_health`, `execution_health`, and `read_health`. - -| deprecated::`alerting_framework_heath` -| This state property has a typo, use `alerting_framework_health` instead. It has three substates that identify the health of the alerting framework API: `decryption_health`, `execution_health`, and `read_health`. - -|=== - -`alerting_framework_health` consists of the following properties: - -[cols="2*<"] -|=== - -| `decryption_health` -| Returns the timestamp and status of the rule decryption: `ok`, `warn` or `error` . - -| `execution_health` -| Returns the timestamp and status of the rule execution: `ok`, `warn` or `error`. - -| `read_health` -| Returns the timestamp and status of the rule reading events: `ok`, `warn` or `error`. - -|=== +<1> `is_sufficiently_secure` is `false` when security is enabled, but TLS is not. +<2> `has_permanent_encryption_key` is `false` when the encrypted saved object +plugin does not have a permanent encryption key. +<3> `alerting_framework_health` has three substates that identify the health of +the alerting framework: `decryption_health`, `execution_health`, and +`read_health`. `decryption_health` returns the timestamp and status of the rule +decryption: `ok`, `warn` or `error`. `execution_health` returns the timestamp +and status of the rule execution: `ok`, `warn` or `error`. `read_health` returns +the timestamp and status of the rule reading events: `ok`, `warn` or `error`. +<4> `alerting_framework_heath` has a typo, use `alerting_framework_health` +instead. deprecated:[8.0.0] diff --git a/docs/api/alerting/update_rule.asciidoc b/docs/api/alerting/update_rule.asciidoc index ecce62912939d..19a9c7c0144b0 100644 --- a/docs/api/alerting/update_rule.asciidoc +++ b/docs/api/alerting/update_rule.asciidoc @@ -15,9 +15,10 @@ Update the attributes for an existing rule. === {api-prereq-title} -You must have `all` privileges for the *Management* > *Stack Rules* feature or -for the *{ml-app}*, *{observability}*, or *Security* features, depending on the -`consumer` and `rule_type_id` of the rule you're updating. If the rule has +You must have `all` privileges for the appropriate {kib} features, depending on +the `consumer` and `rule_type_id` of the rule you're updating. For example, the +*Management* > *Stack Rules* feature, *Analytics* > *Discover* and *{ml-app}* +features, *{observability}*, or *Security* features. If the rule has `actions`, you must also have `read` privileges for the *Management* > *Actions and Connectors* feature. For more details, refer to <>. diff --git a/docs/development/core/public/index.md b/docs/development/core/public/index.md deleted file mode 100644 index 23c347fc16a7a..0000000000000 --- a/docs/development/core/public/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [kibana-plugin-core-public](./kibana-plugin-core-public.md) | The Kibana Core APIs for client-side plugins.A plugin's public/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.approute.md b/docs/development/core/public/kibana-plugin-core-public.app.approute.md deleted file mode 100644 index 357e6400c4e8c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.approute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [appRoute](./kibana-plugin-core-public.app.approute.md) - -## App.appRoute property - -Override the application's routing path from `/app/${id}`. Must be unique across registered applications. Should not include the base path from HTTP. - -Signature: - -```typescript -appRoute?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md deleted file mode 100644 index 4a027a6ab132c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [capabilities](./kibana-plugin-core-public.app.capabilities.md) - -## App.capabilities property - -Custom capabilities defined by the app. - -Signature: - -```typescript -capabilities?: Partial; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.category.md b/docs/development/core/public/kibana-plugin-core-public.app.category.md deleted file mode 100644 index a1e74f2bcf5e2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [category](./kibana-plugin-core-public.app.category.md) - -## App.category property - -The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference - -Signature: - -```typescript -category?: AppCategory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md b/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md deleted file mode 100644 index fe234cac08b68..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.chromeless.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [chromeless](./kibana-plugin-core-public.app.chromeless.md) - -## App.chromeless property - -Hide the UI chrome when the application is mounted. Defaults to `false`. Takes precedence over chrome service visibility settings. - -Signature: - -```typescript -chromeless?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md b/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md deleted file mode 100644 index d9f76fb38a55d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [deepLinks](./kibana-plugin-core-public.app.deeplinks.md) - -## App.deepLinks property - -Input type for registering secondary in-app locations for an application. - -Deep links must include at least one of `path` or `deepLinks`. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. - -Signature: - -```typescript -deepLinks?: AppDeepLink[]; -``` - -## Example - - -```ts -core.application.register({ - id: 'my_app', - title: 'Translated title', - keywords: ['translated keyword1', 'translated keyword2'], - deepLinks: [ - { - id: 'sub1', - title: 'Sub1', - path: '/sub1', - keywords: ['subpath1'], - }, - { - id: 'sub2', - title: 'Sub2', - deepLinks: [ - { - id: 'subsub', - title: 'SubSub', - path: '/sub2/sub', - keywords: ['subpath2'], - }, - ], - }, - ], - mount: () => { ... } -}) -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md b/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md deleted file mode 100644 index 3c952ec053e62..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.defaultpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [defaultPath](./kibana-plugin-core-public.app.defaultpath.md) - -## App.defaultPath property - -Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the `path` option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. - -Signature: - -```typescript -defaultPath?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md b/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md deleted file mode 100644 index 71f6352ec006c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.exactroute.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [exactRoute](./kibana-plugin-core-public.app.exactroute.md) - -## App.exactRoute property - -If set to true, the application's route will only be checked against an exact match. Defaults to `false`. - -Signature: - -```typescript -exactRoute?: boolean; -``` - -## Example - - -```ts -core.application.register({ - id: 'my_app', - title: 'My App', - exactRoute: true, - mount: () => { ... }, -}) - -// '[basePath]/app/my_app' will be matched -// '[basePath]/app/my_app/some/path' will not be matched -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.id.md b/docs/development/core/public/kibana-plugin-core-public.app.id.md deleted file mode 100644 index 39f6e62dae04c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [id](./kibana-plugin-core-public.app.id.md) - -## App.id property - -The unique identifier of the application. - -Can only be composed of alphanumeric characters, `-`, `:` and `_` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.keywords.md b/docs/development/core/public/kibana-plugin-core-public.app.keywords.md deleted file mode 100644 index 585df1b48c16e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.keywords.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [keywords](./kibana-plugin-core-public.app.keywords.md) - -## App.keywords property - -Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. - -Signature: - -```typescript -keywords?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.md b/docs/development/core/public/kibana-plugin-core-public.app.md deleted file mode 100644 index 71bf216f30250..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) - -## App interface - - -Signature: - -```typescript -export interface App extends AppNavOptions -``` -Extends: AppNavOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appRoute?](./kibana-plugin-core-public.app.approute.md) | string | (Optional) Override the application's routing path from /app/${id}. Must be unique across registered applications. Should not include the base path from HTTP. | -| [capabilities?](./kibana-plugin-core-public.app.capabilities.md) | Partial<Capabilities> | (Optional) Custom capabilities defined by the app. | -| [category?](./kibana-plugin-core-public.app.category.md) | AppCategory | (Optional) The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference | -| [chromeless?](./kibana-plugin-core-public.app.chromeless.md) | boolean | (Optional) Hide the UI chrome when the application is mounted. Defaults to false. Takes precedence over chrome service visibility settings. | -| [deepLinks?](./kibana-plugin-core-public.app.deeplinks.md) | AppDeepLink\[\] | (Optional) Input type for registering secondary in-app locations for an application.Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | -| [defaultPath?](./kibana-plugin-core-public.app.defaultpath.md) | string | (Optional) Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the path option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)\`, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. | -| [exactRoute?](./kibana-plugin-core-public.app.exactroute.md) | boolean | (Optional) If set to true, the application's route will only be checked against an exact match. Defaults to false. | -| [id](./kibana-plugin-core-public.app.id.md) | string | The unique identifier of the application.Can only be composed of alphanumeric characters, -, : and _ | -| [keywords?](./kibana-plugin-core-public.app.keywords.md) | string\[\] | (Optional) Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. | -| [mount](./kibana-plugin-core-public.app.mount.md) | AppMount<HistoryLocationState> | A mount function called when the user navigates to this app's route. | -| [navLinkStatus?](./kibana-plugin-core-public.app.navlinkstatus.md) | AppNavLinkStatus | (Optional) The initial status of the application's navLink. Defaulting to visible if status is accessible and hidden if status is inaccessible See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) | -| [searchable?](./kibana-plugin-core-public.app.searchable.md) | boolean | (Optional) The initial flag to determine if the application is searchable in the global search. Defaulting to true if navLinkStatus is visible or omitted. | -| [status?](./kibana-plugin-core-public.app.status.md) | AppStatus | (Optional) The initial status of the application. Defaulting to accessible | -| [title](./kibana-plugin-core-public.app.title.md) | string | The title of the application. | -| [updater$?](./kibana-plugin-core-public.app.updater_.md) | Observable<AppUpdater> | (Optional) An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.app.mount.md b/docs/development/core/public/kibana-plugin-core-public.app.mount.md deleted file mode 100644 index 460ded2a4bff1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.mount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [mount](./kibana-plugin-core-public.app.mount.md) - -## App.mount property - -A mount function called when the user navigates to this app's route. - -Signature: - -```typescript -mount: AppMount; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md b/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md deleted file mode 100644 index c01a26e42e237..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.navlinkstatus.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [navLinkStatus](./kibana-plugin-core-public.app.navlinkstatus.md) - -## App.navLinkStatus property - -The initial status of the application's navLink. Defaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible` See [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) - -Signature: - -```typescript -navLinkStatus?: AppNavLinkStatus; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.searchable.md b/docs/development/core/public/kibana-plugin-core-public.app.searchable.md deleted file mode 100644 index ab1b559a7f6a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.searchable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [searchable](./kibana-plugin-core-public.app.searchable.md) - -## App.searchable property - -The initial flag to determine if the application is searchable in the global search. Defaulting to `true` if `navLinkStatus` is `visible` or omitted. - -Signature: - -```typescript -searchable?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.status.md b/docs/development/core/public/kibana-plugin-core-public.app.status.md deleted file mode 100644 index caa6ff1dcac9e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.status.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [status](./kibana-plugin-core-public.app.status.md) - -## App.status property - -The initial status of the application. Defaulting to `accessible` - -Signature: - -```typescript -status?: AppStatus; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.title.md b/docs/development/core/public/kibana-plugin-core-public.app.title.md deleted file mode 100644 index c705e3ab8d2b1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [title](./kibana-plugin-core-public.app.title.md) - -## App.title property - -The title of the application. - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.app.updater_.md b/docs/development/core/public/kibana-plugin-core-public.app.updater_.md deleted file mode 100644 index e6789a38f12f7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app.updater_.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [updater$](./kibana-plugin-core-public.app.updater_.md) - -## App.updater$ property - -An [AppUpdater](./kibana-plugin-core-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) at runtime. - -Signature: - -```typescript -updater$?: Observable; -``` - -## Example - -How to update an application navLink at runtime - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - private appUpdater = new BehaviorSubject(() => ({})); - - setup({ application }) { - application.register({ - id: 'my-app', - title: 'My App', - updater$: this.appUpdater, - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } - - start() { - // later, when the navlink needs to be updated - appUpdater.next(() => { - navLinkStatus: AppNavLinkStatus.disabled, - }) - } -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md b/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md deleted file mode 100644 index 577c7edbeef4a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.app_wrapper_class.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [APP\_WRAPPER\_CLASS](./kibana-plugin-core-public.app_wrapper_class.md) - -## APP\_WRAPPER\_CLASS variable - -The class name for top level \*and\* nested application wrappers to ensure proper layout - -Signature: - -```typescript -APP_WRAPPER_CLASS = "kbnAppWrapper" -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md deleted file mode 100644 index ff805bd94174a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.arialabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [ariaLabel](./kibana-plugin-core-public.appcategory.arialabel.md) - -## AppCategory.ariaLabel property - -If the visual label isn't appropriate for screen readers, can override it here - -Signature: - -```typescript -ariaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md deleted file mode 100644 index 578f70224342b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [euiIconType](./kibana-plugin-core-public.appcategory.euiicontype.md) - -## AppCategory.euiIconType property - -Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md deleted file mode 100644 index 0342a1d9ee95b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [id](./kibana-plugin-core-public.appcategory.id.md) - -## AppCategory.id property - -Unique identifier for the categories - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md deleted file mode 100644 index 02c000e88f31d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.label.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [label](./kibana-plugin-core-public.appcategory.label.md) - -## AppCategory.label property - -Label used for category name. Also used as aria-label if one isn't set. - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.md deleted file mode 100644 index 40c714b51b8bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) - -## AppCategory interface - -A category definition for nav links to know where to sort them in the left hand nav - -Signature: - -```typescript -export interface AppCategory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ariaLabel?](./kibana-plugin-core-public.appcategory.arialabel.md) | string | (Optional) If the visual label isn't appropriate for screen readers, can override it here | -| [euiIconType?](./kibana-plugin-core-public.appcategory.euiicontype.md) | string | (Optional) Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined | -| [id](./kibana-plugin-core-public.appcategory.id.md) | string | Unique identifier for the categories | -| [label](./kibana-plugin-core-public.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. | -| [order?](./kibana-plugin-core-public.appcategory.order.md) | number | (Optional) The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md b/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md deleted file mode 100644 index 76959c060fa8b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appcategory.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppCategory](./kibana-plugin-core-public.appcategory.md) > [order](./kibana-plugin-core-public.appcategory.order.md) - -## AppCategory.order property - -The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md b/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md deleted file mode 100644 index 30fd3085a4341..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appdeeplink.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) - -## AppDeepLink type - -Input type for registering secondary in-app locations for an application. - -Deep links must include at least one of `path` or `deepLinks`. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. - -Signature: - -```typescript -export declare type AppDeepLink = { - id: string; - title: string; - keywords?: string[]; - navLinkStatus?: AppNavLinkStatus; - searchable?: boolean; -} & AppNavOptions & ({ - path: string; - deepLinks?: AppDeepLink[]; -} | { - path?: string; - deepLinks: AppDeepLink[]; -}); -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md b/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md deleted file mode 100644 index 48323ebaf8e77..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveaction.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) - -## AppLeaveAction type - -Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) - -See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) - -Signature: - -```typescript -export declare type AppLeaveAction = AppLeaveDefaultAction | AppLeaveConfirmAction; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md b/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md deleted file mode 100644 index 9df408c885a18..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveactiontype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveActionType](./kibana-plugin-core-public.appleaveactiontype.md) - -## AppLeaveActionType enum - -Possible type of actions on application leave. - -Signature: - -```typescript -export declare enum AppLeaveActionType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| confirm | "confirm" | | -| default | "default" | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md deleted file mode 100644 index 6a3c790cd17a2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [buttonColor](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md) - -## AppLeaveConfirmAction.buttonColor property - -Signature: - -```typescript -buttonColor?: ButtonColor; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md deleted file mode 100644 index 8ebc9068aa612..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.callback.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [callback](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) - -## AppLeaveConfirmAction.callback property - -Signature: - -```typescript -callback?: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md deleted file mode 100644 index 10ccb6d220f3f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [confirmButtonText](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md) - -## AppLeaveConfirmAction.confirmButtonText property - -Signature: - -```typescript -confirmButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md deleted file mode 100644 index 9f18643787019..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) - -## AppLeaveConfirmAction interface - -Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application. - -See - -Signature: - -```typescript -export interface AppLeaveConfirmAction -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [buttonColor?](./kibana-plugin-core-public.appleaveconfirmaction.buttoncolor.md) | ButtonColor | (Optional) | -| [callback?](./kibana-plugin-core-public.appleaveconfirmaction.callback.md) | () => void | (Optional) | -| [confirmButtonText?](./kibana-plugin-core-public.appleaveconfirmaction.confirmbuttontext.md) | string | (Optional) | -| [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) | string | | -| [title?](./kibana-plugin-core-public.appleaveconfirmaction.title.md) | string | (Optional) | -| [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) | AppLeaveActionType.confirm | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md deleted file mode 100644 index 9caea99fd4a07..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.text.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [text](./kibana-plugin-core-public.appleaveconfirmaction.text.md) - -## AppLeaveConfirmAction.text property - -Signature: - -```typescript -text: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md deleted file mode 100644 index cda43267e3311..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.title.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [title](./kibana-plugin-core-public.appleaveconfirmaction.title.md) - -## AppLeaveConfirmAction.title property - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md b/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md deleted file mode 100644 index fdff75caedc58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleaveconfirmaction.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) > [type](./kibana-plugin-core-public.appleaveconfirmaction.type.md) - -## AppLeaveConfirmAction.type property - -Signature: - -```typescript -type: AppLeaveActionType.confirm; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md b/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md deleted file mode 100644 index 5d0e0d2a216e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) - -## AppLeaveDefaultAction interface - -Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application. - -See - -Signature: - -```typescript -export interface AppLeaveDefaultAction -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) | AppLeaveActionType.default | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md b/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md deleted file mode 100644 index c6bac03c4e002..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavedefaultaction.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) > [type](./kibana-plugin-core-public.appleavedefaultaction.type.md) - -## AppLeaveDefaultAction.type property - -Signature: - -```typescript -type: AppLeaveActionType.default; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md b/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md deleted file mode 100644 index 256ea00e7ef7b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appleavehandler.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) - -## AppLeaveHandler type - -> Warning: This API is now obsolete. -> -> [AppMountParameters.onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) has been deprecated in favor of [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) 8.8.0 -> - -A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return `confirm` to prompt a message to the user before leaving the page, or `default` to keep the default behavior (doing nothing). - -See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. - -Signature: - -```typescript -export declare type AppLeaveHandler = (factory: AppLeaveActionFactory, nextAppId?: string) => AppLeaveAction; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md deleted file mode 100644 index 2e8702a56f309..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -## ApplicationSetup interface - - -Signature: - -```typescript -export interface ApplicationSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [register(app)](./kibana-plugin-core-public.applicationsetup.register.md) | Register an mountable application to the system. | -| [registerAppUpdater(appUpdater$)](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) | Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) fields of all applications at runtime.This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the updater$ property of the registered application instead. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md deleted file mode 100644 index e53b28e88d6ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.register.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [register](./kibana-plugin-core-public.applicationsetup.register.md) - -## ApplicationSetup.register() method - -Register an mountable application to the system. - -Signature: - -```typescript -register(app: App): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| app | App<HistoryLocationState> | an [App](./kibana-plugin-core-public.app.md) | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md b/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md deleted file mode 100644 index 6e8203fd68197..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationsetup.registerappupdater.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) > [registerAppUpdater](./kibana-plugin-core-public.applicationsetup.registerappupdater.md) - -## ApplicationSetup.registerAppUpdater() method - -Register an application updater that can be used to change the [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) fields of all applications at runtime. - -This is meant to be used by plugins that needs to updates the whole list of applications. To only updates a specific application, use the `updater$` property of the registered application instead. - -Signature: - -```typescript -registerAppUpdater(appUpdater$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appUpdater$ | Observable<AppUpdater> | | - -Returns: - -void - -## Example - -How to register an application updater that disables some applications: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.registerAppUpdater( - new BehaviorSubject(app => { - if (myPluginApi.shouldDisable(app)) - return { - status: AppStatus.inaccessible, - }; - }) - ); - } -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md deleted file mode 100644 index bcc5435f35951..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.applications_.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) - -## ApplicationStart.applications$ property - -Observable emitting the list of currently registered apps and their associated status. - -Signature: - -```typescript -applications$: Observable>; -``` - -## Remarks - -Applications disabled by [Capabilities](./kibana-plugin-core-public.capabilities.md) will not be present in the map. Applications manually disabled from the client-side using an [application updater](./kibana-plugin-core-public.appupdater.md) are present, with their status properly set as `inaccessible`. - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md deleted file mode 100644 index 3d9353a246888..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) - -## ApplicationStart.capabilities property - -Gets the read-only capabilities. - -Signature: - -```typescript -capabilities: RecursiveReadonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md deleted file mode 100644 index 1c1e118b8bfac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.currentappid_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) - -## ApplicationStart.currentAppId$ property - -An observable that emits the current application id and each subsequent id update. - -Signature: - -```typescript -currentAppId$: Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md deleted file mode 100644 index 8bc89f617e157..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.geturlforapp.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [getUrlForApp](./kibana-plugin-core-public.applicationstart.geturlforapp.md) - -## ApplicationStart.getUrlForApp() method - -Returns the absolute path (or URL) to a given app, including the global base path. - -By default, it returns the absolute path of the application (e.g `/basePath/app/my-app`). Use the `absolute` option to generate an absolute url instead (e.g `http://host:port/basePath/app/my-app`) - -Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. - -Signature: - -```typescript -getUrlForApp(appId: string, options?: { - path?: string; - absolute?: boolean; - deepLinkId?: string; - }): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appId | string | | -| options | { path?: string; absolute?: boolean; deepLinkId?: string; } | | - -Returns: - -string - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.md deleted file mode 100644 index 62128b840fb78..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) - -## ApplicationStart interface - - -Signature: - -```typescript -export interface ApplicationStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [applications$](./kibana-plugin-core-public.applicationstart.applications_.md) | Observable<ReadonlyMap<string, PublicAppInfo>> | Observable emitting the list of currently registered apps and their associated status. | -| [capabilities](./kibana-plugin-core-public.applicationstart.capabilities.md) | RecursiveReadonly<Capabilities> | Gets the read-only capabilities. | -| [currentAppId$](./kibana-plugin-core-public.applicationstart.currentappid_.md) | Observable<string \| undefined> | An observable that emits the current application id and each subsequent id update. | - -## Methods - -| Method | Description | -| --- | --- | -| [getUrlForApp(appId, options)](./kibana-plugin-core-public.applicationstart.geturlforapp.md) | Returns the absolute path (or URL) to a given app, including the global base path.By default, it returns the absolute path of the application (e.g /basePath/app/my-app). Use the absolute option to generate an absolute url instead (e.g http://host:port/basePath/app/my-app)Note that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location. | -| [navigateToApp(appId, options)](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | Navigate to a given app | -| [navigateToUrl(url, options)](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath).The method resolves pathnames the same way browsers do when resolving a <a href> value. The provided url can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href)If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app// or any application's appRoute configuration)Then a SPA navigation will be performed using navigateToApp using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using window.location.assign. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md deleted file mode 100644 index a6f87209148fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetoapp.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) - -## ApplicationStart.navigateToApp() method - -Navigate to a given app - -Signature: - -```typescript -navigateToApp(appId: string, options?: NavigateToAppOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| appId | string | | -| options | NavigateToAppOptions | navigation options | - -Returns: - -Promise<void> - diff --git a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md b/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md deleted file mode 100644 index b6093340cfbf3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.applicationstart.navigatetourl.md +++ /dev/null @@ -1,50 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) > [navigateToUrl](./kibana-plugin-core-public.applicationstart.navigatetourl.md) - -## ApplicationStart.navigateToUrl() method - -Navigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application within the current basePath). - -The method resolves pathnames the same way browsers do when resolving a `` value. The provided `url` can be: - an absolute URL - an absolute path - a path relative to the current URL (window.location.href) - -If all these criteria are true for the given URL: - (only for absolute URLs) The origin of the URL matches the origin of the browser's current location - The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space) - The pathname segment after the basePath matches any known application route (eg. /app// or any application's `appRoute` configuration) - -Then a SPA navigation will be performed using `navigateToApp` using the corresponding application and path. Otherwise, fallback to a full page reload to navigate to the url using `window.location.assign`. - -Signature: - -```typescript -navigateToUrl(url: string, options?: NavigateToUrlOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | an absolute URL, an absolute path or a relative path, to navigate to. | -| options | NavigateToUrlOptions | navigation options | - -Returns: - -Promise<void> - -## Example - - -```ts -// current url: `https://kibana:8080/base-path/s/my-space/app/dashboard` - -// will call `application.navigateToApp('discover', { path: '/some-path?foo=bar'})` -application.navigateToUrl('https://kibana:8080/base-path/s/my-space/app/discover/some-path?foo=bar') -application.navigateToUrl('/base-path/s/my-space/app/discover/some-path?foo=bar') -application.navigateToUrl('./discover/some-path?foo=bar') - -// will perform a full page reload using `window.location.assign` -application.navigateToUrl('https://elsewhere:8080/base-path/s/my-space/app/discover/some-path') // origin does not match -application.navigateToUrl('/app/discover/some-path') // does not include the current basePath -application.navigateToUrl('/base-path/s/my-space/app/unknown-app/some-path') // unknown application -application.navigateToUrl('../discover') // resolve to `/base-path/s/my-space/discover` which is not a path of a known app. -application.navigateToUrl('../../other-space/discover') // resolve to `/base-path/s/other-space/discover` which is not within the current basePath. -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmount.md b/docs/development/core/public/kibana-plugin-core-public.appmount.md deleted file mode 100644 index 0b02b7df597ae..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMount](./kibana-plugin-core-public.appmount.md) - -## AppMount type - -A mount function called when the user navigates to this app's route. - -Signature: - -```typescript -export declare type AppMount = (params: AppMountParameters) => AppUnmount | Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md deleted file mode 100644 index 09a96cb3ce57a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.appbasepath.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) - -## AppMountParameters.appBasePath property - -> Warning: This API is now obsolete. -> -> Use [AppMountParameters.history](./kibana-plugin-core-public.appmountparameters.history.md) instead. 8.8.0 -> - -The route path for configuring navigation to the application. This string should not include the base path from HTTP. - -Signature: - -```typescript -appBasePath: string; -``` - -## Example - -How to configure react-router with a base path: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.register({ - id: 'my-app', - appRoute: '/my-app', - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } -} -``` - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ appBasePath, element }: AppMountParameters) => { - ReactDOM.render( - // pass `appBasePath` to `basename` - - - , - element - ); - - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md deleted file mode 100644 index 4d8c2a8644ad9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.element.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [element](./kibana-plugin-core-public.appmountparameters.element.md) - -## AppMountParameters.element property - -The container element to render the application into. - -Signature: - -```typescript -element: HTMLElement; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md deleted file mode 100644 index c22267eadbe28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.history.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [history](./kibana-plugin-core-public.appmountparameters.history.md) - -## AppMountParameters.history property - -A scoped history instance for your application. Should be used to wire up your applications Router. - -Signature: - -```typescript -history: ScopedHistory; -``` - -## Example - -How to configure react-router with a base path: - -```ts -// inside your plugin's setup function -export class MyPlugin implements Plugin { - setup({ application }) { - application.register({ - id: 'my-app', - appRoute: '/my-app', - async mount(params) { - const { renderApp } = await import('./application'); - return renderApp(params); - }, - }); - } -} -``` - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { Router, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history }: AppMountParameters) => { - ReactDOM.render( - - - , - element - ); - - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md deleted file mode 100644 index 357998ecaea26..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) - -## AppMountParameters interface - - -Signature: - -```typescript -export interface AppMountParameters -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appBasePath](./kibana-plugin-core-public.appmountparameters.appbasepath.md) | string | The route path for configuring navigation to the application. This string should not include the base path from HTTP. | -| [element](./kibana-plugin-core-public.appmountparameters.element.md) | HTMLElement | The container element to render the application into. | -| [history](./kibana-plugin-core-public.appmountparameters.history.md) | ScopedHistory<HistoryLocationState> | A scoped history instance for your application. Should be used to wire up your applications Router. | -| [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) | (handler: AppLeaveHandler) => void | A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page.This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. | -| [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) | (menuMount: MountPoint \| undefined) => void | A function that can be used to set the mount point used to populate the application action container in the chrome header.Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with undefined will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. | -| [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md) | Observable<CoreTheme> | An observable emitting . Should be used when mounting the application to include theme information. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md deleted file mode 100644 index 67c6d63175591..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.onappleave.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [onAppLeave](./kibana-plugin-core-public.appmountparameters.onappleave.md) - -## AppMountParameters.onAppLeave property - -> Warning: This API is now obsolete. -> -> [ScopedHistory.block](./kibana-plugin-core-public.scopedhistory.block.md) should be used instead. 8.8.0 -> - -A function that can be used to register a handler that will be called when the user is leaving the current application, allowing to prompt a confirmation message before actually changing the page. - -This will be called either when the user goes to another application, or when trying to close the tab or manually changing the url. - -Signature: - -```typescript -onAppLeave: (handler: AppLeaveHandler) => void; -``` - -## Example - - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history, onAppLeave }: AppMountParameters) => { - const { renderApp, hasUnsavedChanges } = await import('./application'); - onAppLeave(actions => { - if(hasUnsavedChanges()) { - return actions.confirm('Some changes were not saved. Are you sure you want to leave?'); - } - return actions.default(); - }); - return renderApp({ element, history }); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md deleted file mode 100644 index 715e1ba4bf291..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [setHeaderActionMenu](./kibana-plugin-core-public.appmountparameters.setheaderactionmenu.md) - -## AppMountParameters.setHeaderActionMenu property - -A function that can be used to set the mount point used to populate the application action container in the chrome header. - -Calling the handler multiple time will erase the current content of the action menu with the mount from the latest call. Calling the handler with `undefined` will unmount the current mount point. Calling the handler after the application has been unmounted will have no effect. - -Signature: - -```typescript -setHeaderActionMenu: (menuMount: MountPoint | undefined) => void; -``` - -## Example - - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; -import { BrowserRouter, Route } from 'react-router-dom'; - -import { CoreStart, AppMountParameters } from 'src/core/public'; -import { MyPluginDepsStart } from './plugin'; - -export renderApp = ({ element, history, setHeaderActionMenu }: AppMountParameters) => { - const { renderApp } = await import('./application'); - const { renderActionMenu } = await import('./action_menu'); - setHeaderActionMenu((element) => { - return renderActionMenu(element); - }) - return renderApp({ element, history }); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md b/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md deleted file mode 100644 index 7c69f76237361..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appmountparameters.theme_.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) > [theme$](./kibana-plugin-core-public.appmountparameters.theme_.md) - -## AppMountParameters.theme$ property - -An observable emitting . Should be used when mounting the application to include theme information. - -Signature: - -```typescript -theme$: Observable; -``` - -## Example - -When mounting a react application: - -```ts -// application.tsx -import React from 'react'; -import ReactDOM from 'react-dom'; - -import { AppMountParameters } from 'src/core/public'; -import { wrapWithTheme } from 'src/plugins/kibana_react'; -import { MyApp } from './app'; - -export renderApp = ({ element, theme$ }: AppMountParameters) => { - ReactDOM.render(wrapWithTheme(, theme$), element); - return () => ReactDOM.unmountComponentAtNode(element); -} -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md b/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md deleted file mode 100644 index 979816249d5cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavlinkstatus.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) - -## AppNavLinkStatus enum - -Status of the application's navLink. - -Signature: - -```typescript -export declare enum AppNavLinkStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| default | 0 | The application navLink will be visible if the application's [AppStatus](./kibana-plugin-core-public.appstatus.md) is set to accessible and hidden if the application status is set to inaccessible. | -| disabled | 2 | The application navLink is visible but inactive and not clickable in the navigation bar. | -| hidden | 3 | The application navLink does not appear in the navigation bar. | -| visible | 1 | The application navLink is visible and clickable in the navigation bar. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md deleted file mode 100644 index ed9d07cd29861..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [euiIconType](./kibana-plugin-core-public.appnavoptions.euiicontype.md) - -## AppNavOptions.euiIconType property - -A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property. - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md deleted file mode 100644 index 3b809fc4aec39..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [icon](./kibana-plugin-core-public.appnavoptions.icon.md) - -## AppNavOptions.icon property - -A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided. - -Signature: - -```typescript -icon?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md deleted file mode 100644 index c6c583b7a9098..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) - -## AppNavOptions interface - -App navigation menu options - -Signature: - -```typescript -export interface AppNavOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [euiIconType?](./kibana-plugin-core-public.appnavoptions.euiicontype.md) | string | (Optional) A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. | -| [icon?](./kibana-plugin-core-public.appnavoptions.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. | -| [order?](./kibana-plugin-core-public.appnavoptions.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. | -| [tooltip?](./kibana-plugin-core-public.appnavoptions.tooltip.md) | string | (Optional) A tooltip shown when hovering over app link. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md deleted file mode 100644 index ca7ae482a04ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [order](./kibana-plugin-core-public.appnavoptions.order.md) - -## AppNavOptions.order property - -An ordinal used to sort nav links relative to one another for display. - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md deleted file mode 100644 index 97c18c2e56a1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appnavoptions.tooltip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) > [tooltip](./kibana-plugin-core-public.appnavoptions.tooltip.md) - -## AppNavOptions.tooltip property - -A tooltip shown when hovering over app link. - -Signature: - -```typescript -tooltip?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appstatus.md b/docs/development/core/public/kibana-plugin-core-public.appstatus.md deleted file mode 100644 index 438d6d7d4728b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appstatus.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppStatus](./kibana-plugin-core-public.appstatus.md) - -## AppStatus enum - -Accessibility status of an application. - -Signature: - -```typescript -export declare enum AppStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| accessible | 0 | Application is accessible. | -| inaccessible | 1 | Application is not accessible. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.appunmount.md b/docs/development/core/public/kibana-plugin-core-public.appunmount.md deleted file mode 100644 index 1c066f67a8ffe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appunmount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUnmount](./kibana-plugin-core-public.appunmount.md) - -## AppUnmount type - -A function called when an application should be unmounted from the page. This function should be synchronous. - -Signature: - -```typescript -export declare type AppUnmount = () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md b/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md deleted file mode 100644 index c24da05abe7ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appupdatablefields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) - -## AppUpdatableFields type - -Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md). - -Signature: - -```typescript -export declare type AppUpdatableFields = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.appupdater.md b/docs/development/core/public/kibana-plugin-core-public.appupdater.md deleted file mode 100644 index 744c52f221da7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.appupdater.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppUpdater](./kibana-plugin-core-public.appupdater.md) - -## AppUpdater type - -Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -Signature: - -```typescript -export declare type AppUpdater = (app: App) => Partial | undefined; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md deleted file mode 100644 index f31b1b3333175..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.catalogue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) - -## Capabilities.catalogue property - -Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. - -Signature: - -```typescript -catalogue: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md deleted file mode 100644 index c1f06e692d638..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.management.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [management](./kibana-plugin-core-public.capabilities.management.md) - -## Capabilities.management property - -Management section capabilities. - -Signature: - -```typescript -management: { - [sectionId: string]: Record; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.md deleted file mode 100644 index e908bd554d88d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) - -## Capabilities interface - -The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. - -Signature: - -```typescript -export interface Capabilities -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [catalogue](./kibana-plugin-core-public.capabilities.catalogue.md) | Record<string, boolean> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. | -| [management](./kibana-plugin-core-public.capabilities.management.md) | { \[sectionId: string\]: Record<string, boolean>; } | Management section capabilities. | -| [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) | Record<string, boolean> | Navigation link capabilities. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md b/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md deleted file mode 100644 index 5f4016ba5a308..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.capabilities.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Capabilities](./kibana-plugin-core-public.capabilities.md) > [navLinks](./kibana-plugin-core-public.capabilities.navlinks.md) - -## Capabilities.navLinks property - -Navigation link capabilities. - -Signature: - -```typescript -navLinks: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md deleted file mode 100644 index 28244a2c9d8c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.icontype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [iconType](./kibana-plugin-core-public.chromebadge.icontype.md) - -## ChromeBadge.iconType property - -Signature: - -```typescript -iconType?: IconType; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.md deleted file mode 100644 index e2e4d1910fdd5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) - -## ChromeBadge interface - - -Signature: - -```typescript -export interface ChromeBadge -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [iconType?](./kibana-plugin-core-public.chromebadge.icontype.md) | IconType | (Optional) | -| [text](./kibana-plugin-core-public.chromebadge.text.md) | string | | -| [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md deleted file mode 100644 index b2b4e415c24c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.text.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [text](./kibana-plugin-core-public.chromebadge.text.md) - -## ChromeBadge.text property - -Signature: - -```typescript -text: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md deleted file mode 100644 index fa22d739e86ee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebadge.tooltip.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) > [tooltip](./kibana-plugin-core-public.chromebadge.tooltip.md) - -## ChromeBadge.tooltip property - -Signature: - -```typescript -tooltip: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md b/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md deleted file mode 100644 index f88e855d436ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromebreadcrumb.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md) - -## ChromeBreadcrumb type - - -Signature: - -```typescript -export declare type ChromeBreadcrumb = EuiBreadcrumb; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md deleted file mode 100644 index cf31d16cae0e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.change.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [change](./kibana-plugin-core-public.chromedoctitle.change.md) - -## ChromeDocTitle.change() method - -Changes the current document title. - -Signature: - -```typescript -change(newTitle: string | string[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newTitle | string \| string\[\] | The new title to set, either a string or string array | - -Returns: - -void - -## Example - -How to change the title of the document - -```ts -chrome.docTitle.change('My application title') -chrome.docTitle.change(['My application', 'My section']) -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md deleted file mode 100644 index 48e04b648e8d8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) - -## ChromeDocTitle interface - -APIs for accessing and updating the document title. - -Signature: - -```typescript -export interface ChromeDocTitle -``` - -## Example 1 - -How to change the title of the document - -```ts -chrome.docTitle.change('My application') -``` - -## Example 2 - -How to reset the title of the document to it's initial value - -```ts -chrome.docTitle.reset() -``` - -## Methods - -| Method | Description | -| --- | --- | -| [change(newTitle)](./kibana-plugin-core-public.chromedoctitle.change.md) | Changes the current document title. | -| [reset()](./kibana-plugin-core-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md b/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md deleted file mode 100644 index e11635fd6d3f8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromedoctitle.reset.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) > [reset](./kibana-plugin-core-public.chromedoctitle.reset.md) - -## ChromeDocTitle.reset() method - -Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) - -Signature: - -```typescript -reset(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md deleted file mode 100644 index 2ac957095c666..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.appname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) - -## ChromeHelpExtension.appName property - -Provide your plugin's name to create a header for separation - -Signature: - -```typescript -appName: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md deleted file mode 100644 index 68e05949e9b1b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.content.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [content](./kibana-plugin-core-public.chromehelpextension.content.md) - -## ChromeHelpExtension.content property - -Custom content to occur below the list of links - -Signature: - -```typescript -content?: (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md deleted file mode 100644 index 41a6b638a3360..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.links.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) > [links](./kibana-plugin-core-public.chromehelpextension.links.md) - -## ChromeHelpExtension.links property - -Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button - -Signature: - -```typescript -links?: ChromeHelpExtensionMenuLink[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md deleted file mode 100644 index 0c038f81edc90..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextension.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) - -## ChromeHelpExtension interface - - -Signature: - -```typescript -export interface ChromeHelpExtension -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appName](./kibana-plugin-core-public.chromehelpextension.appname.md) | string | Provide your plugin's name to create a header for separation | -| [content?](./kibana-plugin-core-public.chromehelpextension.content.md) | (element: HTMLDivElement, menuActions: ChromeHelpMenuActions) => () => void | (Optional) Custom content to occur below the list of links | -| [links?](./kibana-plugin-core-public.chromehelpextension.links.md) | ChromeHelpExtensionMenuLink\[\] | (Optional) Creates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md deleted file mode 100644 index 1faef45c0b2b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionlinkbase.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) - -## ChromeHelpExtensionLinkBase type - - -Signature: - -```typescript -export declare type ChromeHelpExtensionLinkBase = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md deleted file mode 100644 index dc455ca43d24a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) - -## ChromeHelpExtensionMenuCustomLink.content property - -Content of the button (in lieu of `children`) - -Signature: - -```typescript -content: React.ReactNode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md deleted file mode 100644 index feb91acd6d915..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) - -## ChromeHelpExtensionMenuCustomLink.href property - -URL of the link - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md deleted file mode 100644 index a02b219754042..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) - -## ChromeHelpExtensionMenuCustomLink.linkType property - -Extend EuiButtonEmpty to provide extra functionality - -Signature: - -```typescript -linkType: 'custom'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md deleted file mode 100644 index daf724c72c23e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenucustomlink.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) - -## ChromeHelpExtensionMenuCustomLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuCustomLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | React.ReactNode | Content of the button (in lieu of children) | -| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | string | URL of the link | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | 'custom' | Extend EuiButtonEmpty to provide extra functionality | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md deleted file mode 100644 index b6714c39a4699..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) - -## ChromeHelpExtensionMenuDiscussLink.href property - -URL to discuss page. i.e. `https://discuss.elastic.co/c/${appName}` - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md deleted file mode 100644 index 0141677b26a40..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) - -## ChromeHelpExtensionMenuDiscussLink.linkType property - -Creates a generic give feedback link with comment icon - -Signature: - -```typescript -linkType: 'discuss'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md deleted file mode 100644 index 3dc32fcb6d87f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) - -## ChromeHelpExtensionMenuDiscussLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | string | URL to discuss page. i.e. https://discuss.elastic.co/c/${appName} | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | 'discuss' | Creates a generic give feedback link with comment icon | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md deleted file mode 100644 index 9897bc6fcd2f7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) - -## ChromeHelpExtensionMenuDocumentationLink.href property - -URL to documentation page. i.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`, - -Signature: - -```typescript -href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md deleted file mode 100644 index b75a70f9518b3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) - -## ChromeHelpExtensionMenuDocumentationLink.linkType property - -Creates a deep-link to app-specific documentation - -Signature: - -```typescript -linkType: 'documentation'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md deleted file mode 100644 index d20b513b1c550..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) - -## ChromeHelpExtensionMenuDocumentationLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | string | URL to documentation page. i.e. ${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html, | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | 'documentation' | Creates a deep-link to app-specific documentation | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md deleted file mode 100644 index 1976215e7243c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) - -## ChromeHelpExtensionMenuGitHubLink.labels property - -Include at least one app-specific label to be applied to the new github issue - -Signature: - -```typescript -labels: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md deleted file mode 100644 index b3df27213e5b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) - -## ChromeHelpExtensionMenuGitHubLink.linkType property - -Creates a link to a new github issue in the Kibana repo - -Signature: - -```typescript -linkType: 'github'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md deleted file mode 100644 index 56eee43d26902..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) - -## ChromeHelpExtensionMenuGitHubLink interface - - -Signature: - -```typescript -export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase -``` -Extends: ChromeHelpExtensionLinkBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | string\[\] | Include at least one app-specific label to be applied to the new github issue | -| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | 'github' | Creates a link to a new github issue in the Kibana repo | -| [title?](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | string | (Optional) Provides initial text for the title of the issue | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md deleted file mode 100644 index af6091f9e7252..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) > [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) - -## ChromeHelpExtensionMenuGitHubLink.title property - -Provides initial text for the title of the issue - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md deleted file mode 100644 index cb7d795e3eb8e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpextensionmenulink.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) - -## ChromeHelpExtensionMenuLink type - - -Signature: - -```typescript -export declare type ChromeHelpExtensionMenuLink = ChromeHelpExtensionMenuGitHubLink | ChromeHelpExtensionMenuDiscussLink | ChromeHelpExtensionMenuDocumentationLink | ChromeHelpExtensionMenuCustomLink; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md deleted file mode 100644 index bcd67a8fe6f21..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) > [hideHelpMenu](./kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md) - -## ChromeHelpMenuActions.hideHelpMenu property - -Signature: - -```typescript -hideHelpMenu: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md b/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md deleted file mode 100644 index f33581cda5879..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) - -## ChromeHelpMenuActions interface - - -Signature: - -```typescript -export interface ChromeHelpMenuActions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hideHelpMenu](./kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md) | () => void | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md deleted file mode 100644 index c0371078c28a4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) - -## ChromeNavControl interface - - -Signature: - -```typescript -export interface ChromeNavControl -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) | MountPoint | | -| [order?](./kibana-plugin-core-public.chromenavcontrol.order.md) | number | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md deleted file mode 100644 index 911fbe2131b52..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.mount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) > [mount](./kibana-plugin-core-public.chromenavcontrol.mount.md) - -## ChromeNavControl.mount property - -Signature: - -```typescript -mount: MountPoint; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md deleted file mode 100644 index ca6d865a68e4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrol.order.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) > [order](./kibana-plugin-core-public.chromenavcontrol.order.md) - -## ChromeNavControl.order property - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md deleted file mode 100644 index 72018d46428a4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) - -## ChromeNavControls interface - -[APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. - -Signature: - -```typescript -export interface ChromeNavControls -``` - -## Example - -Register a left-side nav control rendered with React. - -```jsx -chrome.navControls.registerLeft({ - mount(targetDomElement) { - ReactDOM.mount(, targetDomElement); - return () => ReactDOM.unmountComponentAtNode(targetDomElement); - } -}) -``` - -## Methods - -| Method | Description | -| --- | --- | -| [registerCenter(navControl)](./kibana-plugin-core-public.chromenavcontrols.registercenter.md) | Register a nav control to be presented on the top-center side of the chrome header. | -| [registerLeft(navControl)](./kibana-plugin-core-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the bottom-left side of the chrome header. | -| [registerRight(navControl)](./kibana-plugin-core-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the top-right side of the chrome header. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md deleted file mode 100644 index 68b243bf47f85..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registercenter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerCenter](./kibana-plugin-core-public.chromenavcontrols.registercenter.md) - -## ChromeNavControls.registerCenter() method - -Register a nav control to be presented on the top-center side of the chrome header. - -Signature: - -```typescript -registerCenter(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md deleted file mode 100644 index ee0789c285f0b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerleft.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerLeft](./kibana-plugin-core-public.chromenavcontrols.registerleft.md) - -## ChromeNavControls.registerLeft() method - -Register a nav control to be presented on the bottom-left side of the chrome header. - -Signature: - -```typescript -registerLeft(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md b/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md deleted file mode 100644 index 9091736c62eeb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavcontrols.registerright.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) > [registerRight](./kibana-plugin-core-public.chromenavcontrols.registerright.md) - -## ChromeNavControls.registerRight() method - -Register a nav control to be presented on the top-right side of the chrome header. - -Signature: - -```typescript -registerRight(navControl: ChromeNavControl): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| navControl | ChromeNavControl | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md deleted file mode 100644 index 88dc54cf823b9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.baseurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) - -## ChromeNavLink.baseUrl property - -The base route used to open the root of an application. - -Signature: - -```typescript -readonly baseUrl: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md deleted file mode 100644 index 1da313365f967..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [category](./kibana-plugin-core-public.chromenavlink.category.md) - -## ChromeNavLink.category property - -The category the app lives in - -Signature: - -```typescript -readonly category?: AppCategory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md deleted file mode 100644 index 2b4d22be187f9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.disabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [disabled](./kibana-plugin-core-public.chromenavlink.disabled.md) - -## ChromeNavLink.disabled property - -Disables a link from being clickable. - -Signature: - -```typescript -readonly disabled?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md deleted file mode 100644 index e30e8262f40b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [euiIconType](./kibana-plugin-core-public.chromenavlink.euiicontype.md) - -## ChromeNavLink.euiIconType property - -A EUI iconType that will be used for the app's icon. This icon takes precedence over the `icon` property. - -Signature: - -```typescript -readonly euiIconType?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md deleted file mode 100644 index 8f8be18fa7bfa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.hidden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [hidden](./kibana-plugin-core-public.chromenavlink.hidden.md) - -## ChromeNavLink.hidden property - -Hides a link from the navigation. - -Signature: - -```typescript -readonly hidden?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md deleted file mode 100644 index f51fa7e5b1355..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.href.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [href](./kibana-plugin-core-public.chromenavlink.href.md) - -## ChromeNavLink.href property - -Settled state between `url`, `baseUrl`, and `active` - -Signature: - -```typescript -readonly href: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md deleted file mode 100644 index dbc922b2a9547..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [icon](./kibana-plugin-core-public.chromenavlink.icon.md) - -## ChromeNavLink.icon property - -A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided. - -Signature: - -```typescript -readonly icon?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md deleted file mode 100644 index a07f7963539ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [id](./kibana-plugin-core-public.chromenavlink.id.md) - -## ChromeNavLink.id property - -A unique identifier for looking up links. - -Signature: - -```typescript -readonly id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md deleted file mode 100644 index 964f4d4b86aaa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) - -## ChromeNavLink interface - - -Signature: - -```typescript -export interface ChromeNavLink -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [baseUrl](./kibana-plugin-core-public.chromenavlink.baseurl.md) | string | The base route used to open the root of an application. | -| [category?](./kibana-plugin-core-public.chromenavlink.category.md) | AppCategory | (Optional) The category the app lives in | -| [disabled?](./kibana-plugin-core-public.chromenavlink.disabled.md) | boolean | (Optional) Disables a link from being clickable. | -| [euiIconType?](./kibana-plugin-core-public.chromenavlink.euiicontype.md) | string | (Optional) A EUI iconType that will be used for the app's icon. This icon takes precedence over the icon property. | -| [hidden?](./kibana-plugin-core-public.chromenavlink.hidden.md) | boolean | (Optional) Hides a link from the navigation. | -| [href](./kibana-plugin-core-public.chromenavlink.href.md) | string | Settled state between url, baseUrl, and active | -| [icon?](./kibana-plugin-core-public.chromenavlink.icon.md) | string | (Optional) A URL to an image file used as an icon. Used as a fallback if euiIconType is not provided. | -| [id](./kibana-plugin-core-public.chromenavlink.id.md) | string | A unique identifier for looking up links. | -| [order?](./kibana-plugin-core-public.chromenavlink.order.md) | number | (Optional) An ordinal used to sort nav links relative to one another for display. | -| [title](./kibana-plugin-core-public.chromenavlink.title.md) | string | The title of the application. | -| [tooltip?](./kibana-plugin-core-public.chromenavlink.tooltip.md) | string | (Optional) A tooltip shown when hovering over an app link. | -| [url](./kibana-plugin-core-public.chromenavlink.url.md) | string | The route used to open the default path and the deep links of an application. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md deleted file mode 100644 index 3597a619a8b20..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [order](./kibana-plugin-core-public.chromenavlink.order.md) - -## ChromeNavLink.order property - -An ordinal used to sort nav links relative to one another for display. - -Signature: - -```typescript -readonly order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md deleted file mode 100644 index 43b1a08755aaf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [title](./kibana-plugin-core-public.chromenavlink.title.md) - -## ChromeNavLink.title property - -The title of the application. - -Signature: - -```typescript -readonly title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md deleted file mode 100644 index 551667dbbb35e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.tooltip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [tooltip](./kibana-plugin-core-public.chromenavlink.tooltip.md) - -## ChromeNavLink.tooltip property - -A tooltip shown when hovering over an app link. - -Signature: - -```typescript -readonly tooltip?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md deleted file mode 100644 index b9d12e450df50..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlink.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) > [url](./kibana-plugin-core-public.chromenavlink.url.md) - -## ChromeNavLink.url property - -The route used to open the default path and the deep links of an application. - -Signature: - -```typescript -readonly url: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md deleted file mode 100644 index 4f9b6aaada5db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [enableForcedAppSwitcherNavigation](./kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md) - -## ChromeNavLinks.enableForcedAppSwitcherNavigation() method - -Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated. - -Signature: - -```typescript -enableForcedAppSwitcherNavigation(): void; -``` -Returns: - -void - -## Remarks - -This is only necessary when rendering the status page in place of another app, as links to that app will set the current URL and change the hash, but the routes for the correct are not loaded so nothing will happen. https://github.com/elastic/kibana/pull/29770 - -Used only by status\_page plugin - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md deleted file mode 100644 index 796d99b9b0e0c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.get.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [get](./kibana-plugin-core-public.chromenavlinks.get.md) - -## ChromeNavLinks.get() method - -Get the state of a navlink at this point in time. - -Signature: - -```typescript -get(id: string): ChromeNavLink | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | - -Returns: - -ChromeNavLink \| undefined - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md deleted file mode 100644 index 08d5707fe3251..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getall.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getAll](./kibana-plugin-core-public.chromenavlinks.getall.md) - -## ChromeNavLinks.getAll() method - -Get the current state of all navlinks. - -Signature: - -```typescript -getAll(): Array>; -``` -Returns: - -Array<Readonly<ChromeNavLink>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md deleted file mode 100644 index 3b87790c37297..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getForceAppSwitcherNavigation$](./kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md) - -## ChromeNavLinks.getForceAppSwitcherNavigation$() method - -An observable of the forced app switcher state. - -Signature: - -```typescript -getForceAppSwitcherNavigation$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md deleted file mode 100644 index 8ee5c0fb83081..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.getnavlinks_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [getNavLinks$](./kibana-plugin-core-public.chromenavlinks.getnavlinks_.md) - -## ChromeNavLinks.getNavLinks$() method - -Get an observable for a sorted list of navlinks. - -Signature: - -```typescript -getNavLinks$(): Observable>>; -``` -Returns: - -Observable<Array<Readonly<ChromeNavLink>>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md deleted file mode 100644 index dfaae86a9d891..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.has.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) > [has](./kibana-plugin-core-public.chromenavlinks.has.md) - -## ChromeNavLinks.has() method - -Check whether or not a navlink exists. - -Signature: - -```typescript -has(id: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md b/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md deleted file mode 100644 index f71eb03d89d72..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromenavlinks.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) - -## ChromeNavLinks interface - -[APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. - -Signature: - -```typescript -export interface ChromeNavLinks -``` - -## Methods - -| Method | Description | -| --- | --- | -| [enableForcedAppSwitcherNavigation()](./kibana-plugin-core-public.chromenavlinks.enableforcedappswitchernavigation.md) | Enable forced navigation mode, which will trigger a page refresh when a nav link is clicked and only the hash is updated. | -| [get(id)](./kibana-plugin-core-public.chromenavlinks.get.md) | Get the state of a navlink at this point in time. | -| [getAll()](./kibana-plugin-core-public.chromenavlinks.getall.md) | Get the current state of all navlinks. | -| [getForceAppSwitcherNavigation$()](./kibana-plugin-core-public.chromenavlinks.getforceappswitchernavigation_.md) | An observable of the forced app switcher state. | -| [getNavLinks$()](./kibana-plugin-core-public.chromenavlinks.getnavlinks_.md) | Get an observable for a sorted list of navlinks. | -| [has(id)](./kibana-plugin-core-public.chromenavlinks.has.md) | Check whether or not a navlink exists. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md deleted file mode 100644 index 5c99c6bf7fbcb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.add.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [add](./kibana-plugin-core-public.chromerecentlyaccessed.add.md) - -## ChromeRecentlyAccessed.add() method - -Adds a new item to the recently accessed history. - -Signature: - -```typescript -add(link: string, label: string, id: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| link | string | a relative URL to the resource (not including the ) | -| label | string | the label to display in the UI | -| id | string | a unique string used to de-duplicate the recently accessed list. | - -Returns: - -void - -## Example - - -```js -chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234'); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md deleted file mode 100644 index da696737b3bb7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [get](./kibana-plugin-core-public.chromerecentlyaccessed.get.md) - -## ChromeRecentlyAccessed.get() method - -Gets an Array of the current recently accessed history. - -Signature: - -```typescript -get(): ChromeRecentlyAccessedHistoryItem[]; -``` -Returns: - -ChromeRecentlyAccessedHistoryItem\[\] - -## Example - - -```js -chrome.recentlyAccessed.get().forEach(console.log); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md deleted file mode 100644 index 4655289642f99..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.get_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) > [get$](./kibana-plugin-core-public.chromerecentlyaccessed.get_.md) - -## ChromeRecentlyAccessed.get$() method - -Gets an Observable of the array of recently accessed history. - -Signature: - -```typescript -get$(): Observable; -``` -Returns: - -Observable<ChromeRecentlyAccessedHistoryItem\[\]> - -## Example - - -```js -chrome.recentlyAccessed.get$().subscribe(console.log); -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md deleted file mode 100644 index 4dad34fe86ed4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessed.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) - -## ChromeRecentlyAccessed interface - -[APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. - -Signature: - -```typescript -export interface ChromeRecentlyAccessed -``` - -## Methods - -| Method | Description | -| --- | --- | -| [add(link, label, id)](./kibana-plugin-core-public.chromerecentlyaccessed.add.md) | Adds a new item to the recently accessed history. | -| [get()](./kibana-plugin-core-public.chromerecentlyaccessed.get.md) | Gets an Array of the current recently accessed history. | -| [get$()](./kibana-plugin-core-public.chromerecentlyaccessed.get_.md) | Gets an Observable of the array of recently accessed history. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md deleted file mode 100644 index daf72d7ebd01c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) - -## ChromeRecentlyAccessedHistoryItem.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md deleted file mode 100644 index 5f55522e4fdf4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) - -## ChromeRecentlyAccessedHistoryItem.label property - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md deleted file mode 100644 index f4b702ba30c96..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) > [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) - -## ChromeRecentlyAccessedHistoryItem.link property - -Signature: - -```typescript -link: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md b/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md deleted file mode 100644 index 3b67b41d37a35..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) - -## ChromeRecentlyAccessedHistoryItem interface - - -Signature: - -```typescript -export interface ChromeRecentlyAccessedHistoryItem -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.id.md) | string | | -| [label](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.label.md) | string | | -| [link](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.link.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md deleted file mode 100644 index c42644eb149c8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.doctitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) - -## ChromeStart.docTitle property - -APIs for accessing and updating the document title. - -Signature: - -```typescript -docTitle: ChromeDocTitle; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md deleted file mode 100644 index d3dc459bae9de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbadge_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBadge$](./kibana-plugin-core-public.chromestart.getbadge_.md) - -## ChromeStart.getBadge$() method - -Get an observable of the current badge - -Signature: - -```typescript -getBadge$(): Observable; -``` -Returns: - -Observable<ChromeBadge \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md deleted file mode 100644 index c4d3751549b16..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbs_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBreadcrumbs$](./kibana-plugin-core-public.chromestart.getbreadcrumbs_.md) - -## ChromeStart.getBreadcrumbs$() method - -Get an observable of the current list of breadcrumbs - -Signature: - -```typescript -getBreadcrumbs$(): Observable; -``` -Returns: - -Observable<ChromeBreadcrumb\[\]> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md deleted file mode 100644 index 21c12514debec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getBreadcrumbsAppendExtension$](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md) - -## ChromeStart.getBreadcrumbsAppendExtension$() method - -Get an observable of the current extension appended to breadcrumbs - -Signature: - -```typescript -getBreadcrumbsAppendExtension$(): Observable; -``` -Returns: - -Observable<ChromeBreadcrumbsAppendExtension \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md deleted file mode 100644 index 59346a409562e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getcustomnavlink_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getCustomNavLink$](./kibana-plugin-core-public.chromestart.getcustomnavlink_.md) - -## ChromeStart.getCustomNavLink$() method - -Get an observable of the current custom nav link - -Signature: - -```typescript -getCustomNavLink$(): Observable | undefined>; -``` -Returns: - -Observable<Partial<ChromeNavLink> \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md deleted file mode 100644 index 052bbe2630f70..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.gethelpextension_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getHelpExtension$](./kibana-plugin-core-public.chromestart.gethelpextension_.md) - -## ChromeStart.getHelpExtension$() method - -Get an observable of the current custom help conttent - -Signature: - -```typescript -getHelpExtension$(): Observable; -``` -Returns: - -Observable<ChromeHelpExtension \| undefined> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md deleted file mode 100644 index 12aa71366aaac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getIsNavDrawerLocked$](./kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md) - -## ChromeStart.getIsNavDrawerLocked$() method - -Get an observable of the current locked state of the nav drawer. - -Signature: - -```typescript -getIsNavDrawerLocked$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md deleted file mode 100644 index 70a9c832926e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.getisvisible_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [getIsVisible$](./kibana-plugin-core-public.chromestart.getisvisible_.md) - -## ChromeStart.getIsVisible$() method - -Get an observable of the current visibility state of the chrome. - -Signature: - -```typescript -getIsVisible$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md deleted file mode 100644 index 66dd1e2562f50..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.hasheaderbanner_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [hasHeaderBanner$](./kibana-plugin-core-public.chromestart.hasheaderbanner_.md) - -## ChromeStart.hasHeaderBanner$() method - -Get an observable of the current header banner presence state. - -Signature: - -```typescript -hasHeaderBanner$(): Observable; -``` -Returns: - -Observable<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.md deleted file mode 100644 index 3e672fbc14d75..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.md +++ /dev/null @@ -1,67 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) - -## ChromeStart interface - -ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. - -Signature: - -```typescript -export interface ChromeStart -``` - -## Remarks - -While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications. - -## Example 1 - -How to add a recently accessed item to the sidebar: - -```ts -core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234'); -``` - -## Example 2 - -How to set the help dropdown extension: - -```tsx -core.chrome.setHelpExtension(elem => { - ReactDOM.render(, elem); - return () => ReactDOM.unmountComponentAtNode(elem); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [docTitle](./kibana-plugin-core-public.chromestart.doctitle.md) | ChromeDocTitle | APIs for accessing and updating the document title. | -| [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) | ChromeNavControls | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. | -| [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) | ChromeNavLinks | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. | -| [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) | ChromeRecentlyAccessed | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. | - -## Methods - -| Method | Description | -| --- | --- | -| [getBadge$()](./kibana-plugin-core-public.chromestart.getbadge_.md) | Get an observable of the current badge | -| [getBreadcrumbs$()](./kibana-plugin-core-public.chromestart.getbreadcrumbs_.md) | Get an observable of the current list of breadcrumbs | -| [getBreadcrumbsAppendExtension$()](./kibana-plugin-core-public.chromestart.getbreadcrumbsappendextension_.md) | Get an observable of the current extension appended to breadcrumbs | -| [getCustomNavLink$()](./kibana-plugin-core-public.chromestart.getcustomnavlink_.md) | Get an observable of the current custom nav link | -| [getHelpExtension$()](./kibana-plugin-core-public.chromestart.gethelpextension_.md) | Get an observable of the current custom help conttent | -| [getIsNavDrawerLocked$()](./kibana-plugin-core-public.chromestart.getisnavdrawerlocked_.md) | Get an observable of the current locked state of the nav drawer. | -| [getIsVisible$()](./kibana-plugin-core-public.chromestart.getisvisible_.md) | Get an observable of the current visibility state of the chrome. | -| [hasHeaderBanner$()](./kibana-plugin-core-public.chromestart.hasheaderbanner_.md) | Get an observable of the current header banner presence state. | -| [setBadge(badge)](./kibana-plugin-core-public.chromestart.setbadge.md) | Override the current badge | -| [setBreadcrumbs(newBreadcrumbs)](./kibana-plugin-core-public.chromestart.setbreadcrumbs.md) | Override the current set of breadcrumbs | -| [setBreadcrumbsAppendExtension(breadcrumbsAppendExtension)](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md) | Mount an element next to the last breadcrumb | -| [setCustomNavLink(newCustomNavLink)](./kibana-plugin-core-public.chromestart.setcustomnavlink.md) | Override the current set of custom nav link | -| [setHeaderBanner(headerBanner)](./kibana-plugin-core-public.chromestart.setheaderbanner.md) | Set the banner that will appear on top of the chrome header. | -| [setHelpExtension(helpExtension)](./kibana-plugin-core-public.chromestart.sethelpextension.md) | Override the current set of custom help content | -| [setHelpSupportUrl(url)](./kibana-plugin-core-public.chromestart.sethelpsupporturl.md) | Override the default support URL shown in the help menu | -| [setIsVisible(isVisible)](./kibana-plugin-core-public.chromestart.setisvisible.md) | Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md deleted file mode 100644 index f2433d98066d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.navcontrols.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [navControls](./kibana-plugin-core-public.chromestart.navcontrols.md) - -## ChromeStart.navControls property - -[APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. - -Signature: - -```typescript -navControls: ChromeNavControls; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md deleted file mode 100644 index fb9222abbb211..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [navLinks](./kibana-plugin-core-public.chromestart.navlinks.md) - -## ChromeStart.navLinks property - -[APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. - -Signature: - -```typescript -navLinks: ChromeNavLinks; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md deleted file mode 100644 index 4eabb5bf0ba23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.recentlyaccessed.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [recentlyAccessed](./kibana-plugin-core-public.chromestart.recentlyaccessed.md) - -## ChromeStart.recentlyAccessed property - -[APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. - -Signature: - -```typescript -recentlyAccessed: ChromeRecentlyAccessed; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md deleted file mode 100644 index 7e974b139d141..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbadge.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBadge](./kibana-plugin-core-public.chromestart.setbadge.md) - -## ChromeStart.setBadge() method - -Override the current badge - -Signature: - -```typescript -setBadge(badge?: ChromeBadge): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| badge | ChromeBadge | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md deleted file mode 100644 index f44e3e6cfd562..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbs.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBreadcrumbs](./kibana-plugin-core-public.chromestart.setbreadcrumbs.md) - -## ChromeStart.setBreadcrumbs() method - -Override the current set of breadcrumbs - -Signature: - -```typescript -setBreadcrumbs(newBreadcrumbs: ChromeBreadcrumb[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newBreadcrumbs | ChromeBreadcrumb\[\] | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md deleted file mode 100644 index b8fa965f2726e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setBreadcrumbsAppendExtension](./kibana-plugin-core-public.chromestart.setbreadcrumbsappendextension.md) - -## ChromeStart.setBreadcrumbsAppendExtension() method - -Mount an element next to the last breadcrumb - -Signature: - -```typescript -setBreadcrumbsAppendExtension(breadcrumbsAppendExtension?: ChromeBreadcrumbsAppendExtension): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| breadcrumbsAppendExtension | ChromeBreadcrumbsAppendExtension | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md deleted file mode 100644 index 7b100a25a4b2b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setcustomnavlink.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setCustomNavLink](./kibana-plugin-core-public.chromestart.setcustomnavlink.md) - -## ChromeStart.setCustomNavLink() method - -Override the current set of custom nav link - -Signature: - -```typescript -setCustomNavLink(newCustomNavLink?: Partial): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newCustomNavLink | Partial<ChromeNavLink> | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md deleted file mode 100644 index 75f711c0bf10b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setheaderbanner.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHeaderBanner](./kibana-plugin-core-public.chromestart.setheaderbanner.md) - -## ChromeStart.setHeaderBanner() method - -Set the banner that will appear on top of the chrome header. - -Signature: - -```typescript -setHeaderBanner(headerBanner?: ChromeUserBanner): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| headerBanner | ChromeUserBanner | | - -Returns: - -void - -## Remarks - -Using `undefined` when invoking this API will remove the banner. - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md deleted file mode 100644 index c2bc691349f3c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpextension.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHelpExtension](./kibana-plugin-core-public.chromestart.sethelpextension.md) - -## ChromeStart.setHelpExtension() method - -Override the current set of custom help content - -Signature: - -```typescript -setHelpExtension(helpExtension?: ChromeHelpExtension): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| helpExtension | ChromeHelpExtension | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md deleted file mode 100644 index baeb37a89ca44..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.sethelpsupporturl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setHelpSupportUrl](./kibana-plugin-core-public.chromestart.sethelpsupporturl.md) - -## ChromeStart.setHelpSupportUrl() method - -Override the default support URL shown in the help menu - -Signature: - -```typescript -setHelpSupportUrl(url: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | The updated support URL | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md b/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md deleted file mode 100644 index 9c8cc737bea4f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromestart.setisvisible.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeStart](./kibana-plugin-core-public.chromestart.md) > [setIsVisible](./kibana-plugin-core-public.chromestart.setisvisible.md) - -## ChromeStart.setIsVisible() method - -Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. - -Signature: - -```typescript -setIsVisible(isVisible: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| isVisible | boolean | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md b/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md deleted file mode 100644 index 7a77fdc6223de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.content.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) > [content](./kibana-plugin-core-public.chromeuserbanner.content.md) - -## ChromeUserBanner.content property - -Signature: - -```typescript -content: MountPoint; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md b/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md deleted file mode 100644 index 0417197ab55f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.chromeuserbanner.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) - -## ChromeUserBanner interface - - -Signature: - -```typescript -export interface ChromeUserBanner -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [content](./kibana-plugin-core-public.chromeuserbanner.content.md) | MountPoint<HTMLDivElement> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md deleted file mode 100644 index 209a4e862589b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.analytics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [analytics](./kibana-plugin-core-public.coresetup.analytics.md) - -## CoreSetup.analytics property - - -Signature: - -```typescript -analytics: AnalyticsServiceSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md deleted file mode 100644 index 70a1f3780577c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.application.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [application](./kibana-plugin-core-public.coresetup.application.md) - -## CoreSetup.application property - -[ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) - -Signature: - -```typescript -application: ApplicationSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md deleted file mode 100644 index be5689ad7b080..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md) - -## CoreSetup.executionContext property - -[ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) - -Signature: - -```typescript -executionContext: ExecutionContextSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md deleted file mode 100644 index 86f734c4b5c06..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.fatalerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) - -## CoreSetup.fatalErrors property - -[FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) - -Signature: - -```typescript -fatalErrors: FatalErrorsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md deleted file mode 100644 index 8664ad0e2a0e5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.getstartservices.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) - -## CoreSetup.getStartServices property - -[StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) - -Signature: - -```typescript -getStartServices: StartServicesAccessor; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md deleted file mode 100644 index d9b2599b0f80a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [http](./kibana-plugin-core-public.coresetup.http.md) - -## CoreSetup.http property - -[HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -Signature: - -```typescript -http: HttpSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md deleted file mode 100644 index 661702f2d466e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) - -## CoreSetup.injectedMetadata property - - -Signature: - -```typescript -injectedMetadata: InjectedMetadataSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.md deleted file mode 100644 index 051aa0218eca7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) - -## CoreSetup interface - -Core services exposed to the `Plugin` setup lifecycle - -Signature: - -```typescript -export interface CoreSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-public.coresetup.analytics.md) | AnalyticsServiceSetup | | -| [application](./kibana-plugin-core-public.coresetup.application.md) | ApplicationSetup | [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | -| [executionContext](./kibana-plugin-core-public.coresetup.executioncontext.md) | ExecutionContextSetup | [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) | -| [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | FatalErrorsSetup | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | -| [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | StartServicesAccessor<TPluginsStart, TStart> | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) | -| [http](./kibana-plugin-core-public.coresetup.http.md) | HttpSetup | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | -| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | InjectedMetadataSetup | | -| [notifications](./kibana-plugin-core-public.coresetup.notifications.md) | NotificationsSetup | [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) | -| [theme](./kibana-plugin-core-public.coresetup.theme.md) | ThemeServiceSetup | | -| [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md deleted file mode 100644 index 9f5770539c83e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.notifications.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [notifications](./kibana-plugin-core-public.coresetup.notifications.md) - -## CoreSetup.notifications property - -[NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) - -Signature: - -```typescript -notifications: NotificationsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md deleted file mode 100644 index d1db31894563e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.theme.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [theme](./kibana-plugin-core-public.coresetup.theme.md) - -## CoreSetup.theme property - - -Signature: - -```typescript -theme: ThemeServiceSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md b/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md deleted file mode 100644 index 60a7a2a984ba8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.coresetup.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreSetup](./kibana-plugin-core-public.coresetup.md) > [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) - -## CoreSetup.uiSettings property - -[IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -uiSettings: IUiSettingsClient; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md b/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md deleted file mode 100644 index 0a12fa8e26164..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.analytics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [analytics](./kibana-plugin-core-public.corestart.analytics.md) - -## CoreStart.analytics property - - -Signature: - -```typescript -analytics: AnalyticsServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.application.md b/docs/development/core/public/kibana-plugin-core-public.corestart.application.md deleted file mode 100644 index 95c1360098afe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.application.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [application](./kibana-plugin-core-public.corestart.application.md) - -## CoreStart.application property - -[ApplicationStart](./kibana-plugin-core-public.applicationstart.md) - -Signature: - -```typescript -application: ApplicationStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md b/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md deleted file mode 100644 index 38d72c54db264..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.chrome.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [chrome](./kibana-plugin-core-public.corestart.chrome.md) - -## CoreStart.chrome property - -[ChromeStart](./kibana-plugin-core-public.chromestart.md) - -Signature: - -```typescript -chrome: ChromeStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md b/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md deleted file mode 100644 index 624c4868d54a7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) - -## CoreStart.deprecations property - -[DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) - -Signature: - -```typescript -deprecations: DeprecationsServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md b/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md deleted file mode 100644 index 014e40b3e2203..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) - -## CoreStart.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md b/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md deleted file mode 100644 index 4a2239ee6a738..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) - -## CoreStart.executionContext property - -[ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) - -Signature: - -```typescript -executionContext: ExecutionContextStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md b/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md deleted file mode 100644 index 609d710618386..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.fatalerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) - -## CoreStart.fatalErrors property - -[FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) - -Signature: - -```typescript -fatalErrors: FatalErrorsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.http.md b/docs/development/core/public/kibana-plugin-core-public.corestart.http.md deleted file mode 100644 index b2123d149762d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [http](./kibana-plugin-core-public.corestart.http.md) - -## CoreStart.http property - -[HttpStart](./kibana-plugin-core-public.httpstart.md) - -Signature: - -```typescript -http: HttpStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md b/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md deleted file mode 100644 index 22ded9881e57e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.i18n.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [i18n](./kibana-plugin-core-public.corestart.i18n.md) - -## CoreStart.i18n property - -[I18nStart](./kibana-plugin-core-public.i18nstart.md) - -Signature: - -```typescript -i18n: I18nStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md b/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md deleted file mode 100644 index 57fadf8ea3354..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) - -## CoreStart.injectedMetadata property - - -Signature: - -```typescript -injectedMetadata: InjectedMetadataStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.md b/docs/development/core/public/kibana-plugin-core-public.corestart.md deleted file mode 100644 index 3ced931f53c7e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) - -## CoreStart interface - -Core services exposed to the `Plugin` start lifecycle - -Signature: - -```typescript -export interface CoreStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-public.corestart.analytics.md) | AnalyticsServiceStart | | -| [application](./kibana-plugin-core-public.corestart.application.md) | ApplicationStart | [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | -| [chrome](./kibana-plugin-core-public.corestart.chrome.md) | ChromeStart | [ChromeStart](./kibana-plugin-core-public.chromestart.md) | -| [deprecations](./kibana-plugin-core-public.corestart.deprecations.md) | DeprecationsServiceStart | [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | -| [docLinks](./kibana-plugin-core-public.corestart.doclinks.md) | DocLinksStart | | -| [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) | ExecutionContextStart | [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) | -| [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | FatalErrorsStart | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | -| [http](./kibana-plugin-core-public.corestart.http.md) | HttpStart | [HttpStart](./kibana-plugin-core-public.httpstart.md) | -| [i18n](./kibana-plugin-core-public.corestart.i18n.md) | I18nStart | [I18nStart](./kibana-plugin-core-public.i18nstart.md) | -| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | InjectedMetadataStart | | -| [notifications](./kibana-plugin-core-public.corestart.notifications.md) | NotificationsStart | [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) | -| [overlays](./kibana-plugin-core-public.corestart.overlays.md) | OverlayStart | [OverlayStart](./kibana-plugin-core-public.overlaystart.md) | -| [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) | SavedObjectsStart | [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) | -| [theme](./kibana-plugin-core-public.corestart.theme.md) | ThemeServiceStart | | -| [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md b/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md deleted file mode 100644 index 4e4e509e88e81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.notifications.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [notifications](./kibana-plugin-core-public.corestart.notifications.md) - -## CoreStart.notifications property - -[NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) - -Signature: - -```typescript -notifications: NotificationsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md b/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md deleted file mode 100644 index d65ac50b495ba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.overlays.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [overlays](./kibana-plugin-core-public.corestart.overlays.md) - -## CoreStart.overlays property - -[OverlayStart](./kibana-plugin-core-public.overlaystart.md) - -Signature: - -```typescript -overlays: OverlayStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md b/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md deleted file mode 100644 index 5216367abe293..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) - -## CoreStart.savedObjects property - -[SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) - -Signature: - -```typescript -savedObjects: SavedObjectsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md b/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md deleted file mode 100644 index 6482581805b46..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.theme.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [theme](./kibana-plugin-core-public.corestart.theme.md) - -## CoreStart.theme property - - -Signature: - -```typescript -theme: ThemeServiceStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md b/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md deleted file mode 100644 index 48348a5843963..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.corestart.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [uiSettings](./kibana-plugin-core-public.corestart.uisettings.md) - -## CoreStart.uiSettings property - -[IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -uiSettings: IUiSettingsClient; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md deleted file mode 100644 index 8175da8a1893a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) - -## DeprecationsServiceStart.getAllDeprecations property - -Grabs deprecations details for all domains. - -Signature: - -```typescript -getAllDeprecations: () => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md deleted file mode 100644 index 6e3472b7c3fe3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) - -## DeprecationsServiceStart.getDeprecations property - -Grabs deprecations for a specific domain. - -Signature: - -```typescript -getDeprecations: (domainId: string) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md deleted file mode 100644 index 842761f6b7cea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) - -## DeprecationsServiceStart.isDeprecationResolvable property - -Returns a boolean if the provided deprecation can be automatically resolvable. - -Signature: - -```typescript -isDeprecationResolvable: (details: DomainDeprecationDetails) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md deleted file mode 100644 index bfc1d78f4d045..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) - -## DeprecationsServiceStart interface - -DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. - -Signature: - -```typescript -export interface DeprecationsServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getAllDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getalldeprecations.md) | () => Promise<DomainDeprecationDetails\[\]> | Grabs deprecations details for all domains. | -| [getDeprecations](./kibana-plugin-core-public.deprecationsservicestart.getdeprecations.md) | (domainId: string) => Promise<DomainDeprecationDetails\[\]> | Grabs deprecations for a specific domain. | -| [isDeprecationResolvable](./kibana-plugin-core-public.deprecationsservicestart.isdeprecationresolvable.md) | (details: DomainDeprecationDetails) => boolean | Returns a boolean if the provided deprecation can be automatically resolvable. | -| [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) | (details: DomainDeprecationDetails) => Promise<ResolveDeprecationResponse> | Calls the correctiveActions.api to automatically resolve the depprecation. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md b/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md deleted file mode 100644 index fae623fed3cc2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) > [resolveDeprecation](./kibana-plugin-core-public.deprecationsservicestart.resolvedeprecation.md) - -## DeprecationsServiceStart.resolveDeprecation property - -Calls the correctiveActions.api to automatically resolve the depprecation. - -Signature: - -```typescript -resolveDeprecation: (details: DomainDeprecationDetails) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md deleted file mode 100644 index c2bddc58d9c3b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) - -## ErrorToastOptions interface - -Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. - -Signature: - -```typescript -export interface ErrorToastOptions extends ToastOptions -``` -Extends: ToastOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [title](./kibana-plugin-core-public.errortoastoptions.title.md) | string | The title of the toast and the dialog when expanding the message. | -| [toastMessage?](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) | string | (Optional) The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md deleted file mode 100644 index bad316896cf5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) > [title](./kibana-plugin-core-public.errortoastoptions.title.md) - -## ErrorToastOptions.title property - -The title of the toast and the dialog when expanding the message. - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md b/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md deleted file mode 100644 index a96143a94b211..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.errortoastoptions.toastmessage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) > [toastMessage](./kibana-plugin-core-public.errortoastoptions.toastmessage.md) - -## ErrorToastOptions.toastMessage property - -The message to be shown in the toast. If this is not specified the error's message will be shown in the toast instead. Overwriting that message can be used to provide more user-friendly toasts. If you specify this, the error message will still be shown in the detailed error modal. - -Signature: - -```typescript -toastMessage?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md deleted file mode 100644 index 94936b94d0710..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.clear.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [clear](./kibana-plugin-core-public.executioncontextsetup.clear.md) - -## ExecutionContextSetup.clear() method - -clears the context - -Signature: - -```typescript -clear(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md deleted file mode 100644 index d6c74db6d603e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.context_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [context$](./kibana-plugin-core-public.executioncontextsetup.context_.md) - -## ExecutionContextSetup.context$ property - -The current context observable - -Signature: - -```typescript -context$: Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md deleted file mode 100644 index 65e9b1218649d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.get.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [get](./kibana-plugin-core-public.executioncontextsetup.get.md) - -## ExecutionContextSetup.get() method - -Get the current top level context - -Signature: - -```typescript -get(): KibanaExecutionContext; -``` -Returns: - -KibanaExecutionContext - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md deleted file mode 100644 index 0f0bda4e2913e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.getaslabels.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [getAsLabels](./kibana-plugin-core-public.executioncontextsetup.getaslabels.md) - -## ExecutionContextSetup.getAsLabels() method - -returns apm labels - -Signature: - -```typescript -getAsLabels(): Labels; -``` -Returns: - -Labels - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md deleted file mode 100644 index 01581d2e80a5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) - -## ExecutionContextSetup interface - -Kibana execution context. Used to provide execution context to Elasticsearch, reporting, performance monitoring, etc. - -Signature: - -```typescript -export interface ExecutionContextSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context$](./kibana-plugin-core-public.executioncontextsetup.context_.md) | Observable<KibanaExecutionContext> | The current context observable | - -## Methods - -| Method | Description | -| --- | --- | -| [clear()](./kibana-plugin-core-public.executioncontextsetup.clear.md) | clears the context | -| [get()](./kibana-plugin-core-public.executioncontextsetup.get.md) | Get the current top level context | -| [getAsLabels()](./kibana-plugin-core-public.executioncontextsetup.getaslabels.md) | returns apm labels | -| [set(c$)](./kibana-plugin-core-public.executioncontextsetup.set.md) | Set the current top level context | -| [withGlobalContext(context)](./kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md) | merges the current top level context with the specific event context | - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md deleted file mode 100644 index e3dcea78c827a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.set.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [set](./kibana-plugin-core-public.executioncontextsetup.set.md) - -## ExecutionContextSetup.set() method - -Set the current top level context - -Signature: - -```typescript -set(c$: KibanaExecutionContext): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| c$ | KibanaExecutionContext | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md deleted file mode 100644 index 574d0fd989750..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) > [withGlobalContext](./kibana-plugin-core-public.executioncontextsetup.withglobalcontext.md) - -## ExecutionContextSetup.withGlobalContext() method - -merges the current top level context with the specific event context - -Signature: - -```typescript -withGlobalContext(context?: KibanaExecutionContext): KibanaExecutionContext; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | KibanaExecutionContext | | - -Returns: - -KibanaExecutionContext - diff --git a/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md b/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md deleted file mode 100644 index 0d210ba5bb1c4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.executioncontextstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) - -## ExecutionContextStart type - -See [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md). - -Signature: - -```typescript -export declare type ExecutionContextStart = ExecutionContextSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md deleted file mode 100644 index 9b2803e4f12ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) - -## FatalErrorInfo interface - -Represents the `message` and `stack` of a fatal Error - -Signature: - -```typescript -export interface FatalErrorInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) | string | | -| [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) | string \| undefined | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md deleted file mode 100644 index c623f7e6bf910..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) > [message](./kibana-plugin-core-public.fatalerrorinfo.message.md) - -## FatalErrorInfo.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md deleted file mode 100644 index 5f8052be6a77a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorinfo.stack.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) > [stack](./kibana-plugin-core-public.fatalerrorinfo.stack.md) - -## FatalErrorInfo.stack property - -Signature: - -```typescript -stack: string | undefined; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md deleted file mode 100644 index 0b2a064a4c7df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.add.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) > [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) - -## FatalErrorsSetup.add property - -Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -add: (error: string | Error, source?: string) => never; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md deleted file mode 100644 index 15bf94d5b7cd6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.get_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) > [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) - -## FatalErrorsSetup.get$ property - -An Observable that will emit whenever a fatal error is added with `add()` - -Signature: - -```typescript -get$: () => Rx.Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md deleted file mode 100644 index 1f27fd52b7e32..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorssetup.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) - -## FatalErrorsSetup interface - -FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -export interface FatalErrorsSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](./kibana-plugin-core-public.fatalerrorssetup.add.md) | (error: string \| Error, source?: string) => never | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. | -| [get$](./kibana-plugin-core-public.fatalerrorssetup.get_.md) | () => Rx.Observable<FatalErrorInfo> | An Observable that will emit whenever a fatal error is added with add() | - diff --git a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md b/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md deleted file mode 100644 index dd462eb435369..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.fatalerrorsstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) - -## FatalErrorsStart type - -FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. - -Signature: - -```typescript -export declare type FatalErrorsStart = FatalErrorsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md deleted file mode 100644 index 264e00a73fd2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.asresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [asResponse](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) - -## HttpFetchOptions.asResponse property - -When `true` the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When `false`, the return type will just be the parsed response body. Defaults to `false`. - -Signature: - -```typescript -asResponse?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md deleted file mode 100644 index f74a9d02f8420..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.assystemrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [asSystemRequest](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) - -## HttpFetchOptions.asSystemRequest property - -Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to `false`. - -Signature: - -```typescript -asSystemRequest?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md deleted file mode 100644 index 09ab95a5135f6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [context](./kibana-plugin-core-public.httpfetchoptions.context.md) - -## HttpFetchOptions.context property - -Signature: - -```typescript -context?: KibanaExecutionContext; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md deleted file mode 100644 index b29725b727cdb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [headers](./kibana-plugin-core-public.httpfetchoptions.headers.md) - -## HttpFetchOptions.headers property - -Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). - -Signature: - -```typescript -headers?: HttpHeadersInit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md deleted file mode 100644 index 9a7f05ab9cd3e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) - -## HttpFetchOptions interface - -All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md). - -Signature: - -```typescript -export interface HttpFetchOptions extends HttpRequestInit -``` -Extends: HttpRequestInit - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asResponse?](./kibana-plugin-core-public.httpfetchoptions.asresponse.md) | boolean | (Optional) When true the return type of [HttpHandler](./kibana-plugin-core-public.httphandler.md) will be an [HttpResponse](./kibana-plugin-core-public.httpresponse.md) with detailed request and response information. When false, the return type will just be the parsed response body. Defaults to false. | -| [asSystemRequest?](./kibana-plugin-core-public.httpfetchoptions.assystemrequest.md) | boolean | (Optional) Whether or not the request should include the "system request" header to differentiate an end user request from Kibana internal request. Can be read on the server-side using KibanaRequest\#isSystemRequest. Defaults to false. | -| [context?](./kibana-plugin-core-public.httpfetchoptions.context.md) | KibanaExecutionContext | (Optional) | -| [headers?](./kibana-plugin-core-public.httpfetchoptions.headers.md) | HttpHeadersInit | (Optional) Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md). | -| [prependBasePath?](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) | boolean | (Optional) Whether or not the request should automatically prepend the basePath. Defaults to true. | -| [query?](./kibana-plugin-core-public.httpfetchoptions.query.md) | HttpFetchQuery | (Optional) The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md deleted file mode 100644 index ca638d472c52f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.prependbasepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [prependBasePath](./kibana-plugin-core-public.httpfetchoptions.prependbasepath.md) - -## HttpFetchOptions.prependBasePath property - -Whether or not the request should automatically prepend the basePath. Defaults to `true`. - -Signature: - -```typescript -prependBasePath?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md deleted file mode 100644 index b03e48aa15cc5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [query](./kibana-plugin-core-public.httpfetchoptions.query.md) - -## HttpFetchOptions.query property - -The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md). - -Signature: - -```typescript -query?: HttpFetchQuery; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md deleted file mode 100644 index 78155adaf627e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) - -## HttpFetchOptionsWithPath interface - -Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included. - -Signature: - -```typescript -export interface HttpFetchOptionsWithPath extends HttpFetchOptions -``` -Extends: HttpFetchOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md deleted file mode 100644 index b360d7d1fb824..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchoptionswithpath.path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) > [path](./kibana-plugin-core-public.httpfetchoptionswithpath.path.md) - -## HttpFetchOptionsWithPath.path property - -Signature: - -```typescript -path: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md b/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md deleted file mode 100644 index 29627ddd122fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpfetchquery.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md) - -## HttpFetchQuery interface - - -Signature: - -```typescript -export interface HttpFetchQuery -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httphandler.md b/docs/development/core/public/kibana-plugin-core-public.httphandler.md deleted file mode 100644 index 6a119b186bfa1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httphandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpHandler](./kibana-plugin-core-public.httphandler.md) - -## HttpHandler interface - -A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-core-public.httpresponse.md) for the response. - -Signature: - -```typescript -export interface HttpHandler -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md b/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md deleted file mode 100644 index e05303a23afc8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpheadersinit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) - -## HttpHeadersInit interface - -Headers to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause [HttpHandler](./kibana-plugin-core-public.httphandler.md) to throw an error. - -Signature: - -```typescript -export interface HttpHeadersInit -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md deleted file mode 100644 index e1843b1a52988..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) - -## HttpInterceptor interface - -An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md). - -Signature: - -```typescript -export interface HttpInterceptor -``` - -## Methods - -| Method | Description | -| --- | --- | -| [request(fetchOptions, controller)?](./kibana-plugin-core-public.httpinterceptor.request.md) | (Optional) Define an interceptor to be executed before a request is sent. | -| [requestError(httpErrorRequest, controller)?](./kibana-plugin-core-public.httpinterceptor.requesterror.md) | (Optional) Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. | -| [response(httpResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.response.md) | (Optional) Define an interceptor to be executed after a response is received. | -| [responseError(httpErrorResponse, controller)?](./kibana-plugin-core-public.httpinterceptor.responseerror.md) | (Optional) Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md deleted file mode 100644 index 95181e6d509f1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.request.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [request](./kibana-plugin-core-public.httpinterceptor.request.md) - -## HttpInterceptor.request() method - -Define an interceptor to be executed before a request is sent. - -Signature: - -```typescript -request?(fetchOptions: Readonly, controller: IHttpInterceptController): MaybePromise> | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| fetchOptions | Readonly<HttpFetchOptionsWithPath> | | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<Partial<HttpFetchOptionsWithPath>> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md deleted file mode 100644 index c2bd14a6d1ead..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.requesterror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [requestError](./kibana-plugin-core-public.httpinterceptor.requesterror.md) - -## HttpInterceptor.requestError() method - -Define an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise. - -Signature: - -```typescript -requestError?(httpErrorRequest: HttpInterceptorRequestError, controller: IHttpInterceptController): MaybePromise> | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpErrorRequest | HttpInterceptorRequestError | [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<Partial<HttpFetchOptionsWithPath>> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md deleted file mode 100644 index 40cfeffacc0ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [response](./kibana-plugin-core-public.httpinterceptor.response.md) - -## HttpInterceptor.response() method - -Define an interceptor to be executed after a response is received. - -Signature: - -```typescript -response?(httpResponse: HttpResponse, controller: IHttpInterceptController): MaybePromise | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpResponse | HttpResponse | [HttpResponse](./kibana-plugin-core-public.httpresponse.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<IHttpResponseInterceptorOverrides> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md deleted file mode 100644 index d9be2e87761fc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptor.responseerror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) > [responseError](./kibana-plugin-core-public.httpinterceptor.responseerror.md) - -## HttpInterceptor.responseError() method - -Define an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise. - -Signature: - -```typescript -responseError?(httpErrorResponse: HttpInterceptorResponseError, controller: IHttpInterceptController): MaybePromise | void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| httpErrorResponse | HttpInterceptorResponseError | [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) | -| controller | IHttpInterceptController | [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | - -Returns: - -MaybePromise<IHttpResponseInterceptorOverrides> \| void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md deleted file mode 100644 index a5db2cb2664c1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) > [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) - -## HttpInterceptorRequestError.error property - -Signature: - -```typescript -error: Error; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md deleted file mode 100644 index 68c338b4f974d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) > [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) - -## HttpInterceptorRequestError.fetchOptions property - -Signature: - -```typescript -fetchOptions: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md deleted file mode 100644 index 499bc61ce68af..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorrequesterror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) - -## HttpInterceptorRequestError interface - - -Signature: - -```typescript -export interface HttpInterceptorRequestError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.httpinterceptorrequesterror.error.md) | Error | | -| [fetchOptions](./kibana-plugin-core-public.httpinterceptorrequesterror.fetchoptions.md) | Readonly<HttpFetchOptionsWithPath> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md deleted file mode 100644 index e69a3c04d1dec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) > [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) - -## HttpInterceptorResponseError.error property - -Signature: - -```typescript -error: Error | IHttpFetchError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md deleted file mode 100644 index 014cebeb3ec4d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) - -## HttpInterceptorResponseError interface - - -Signature: - -```typescript -export interface HttpInterceptorResponseError extends HttpResponse -``` -Extends: HttpResponse - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.httpinterceptorresponseerror.error.md) | Error \| IHttpFetchError | | -| [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) | Readonly<Request> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md b/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md deleted file mode 100644 index 4e4d1bbdeec28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpinterceptorresponseerror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) > [request](./kibana-plugin-core-public.httpinterceptorresponseerror.request.md) - -## HttpInterceptorResponseError.request property - -Signature: - -```typescript -request: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md deleted file mode 100644 index dddf1ea87ec43..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [body](./kibana-plugin-core-public.httprequestinit.body.md) - -## HttpRequestInit.body property - -A BodyInit object or null to set request's body. - -Signature: - -```typescript -body?: BodyInit | null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md deleted file mode 100644 index cc7ef0bf2f3c2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.cache.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [cache](./kibana-plugin-core-public.httprequestinit.cache.md) - -## HttpRequestInit.cache property - -The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. - -Signature: - -```typescript -cache?: RequestCache; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md deleted file mode 100644 index da05b9eb2e319..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.credentials.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [credentials](./kibana-plugin-core-public.httprequestinit.credentials.md) - -## HttpRequestInit.credentials property - -The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. - -Signature: - -```typescript -credentials?: RequestCredentials; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md deleted file mode 100644 index 64e79dc55d25d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [headers](./kibana-plugin-core-public.httprequestinit.headers.md) - -## HttpRequestInit.headers property - -[HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) - -Signature: - -```typescript -headers?: HttpHeadersInit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md deleted file mode 100644 index 34d9d2f60c969..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.integrity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [integrity](./kibana-plugin-core-public.httprequestinit.integrity.md) - -## HttpRequestInit.integrity property - -Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. - -Signature: - -```typescript -integrity?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md deleted file mode 100644 index 3be81e863f5fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.keepalive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [keepalive](./kibana-plugin-core-public.httprequestinit.keepalive.md) - -## HttpRequestInit.keepalive property - -Whether or not request can outlive the global in which it was created. - -Signature: - -```typescript -keepalive?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md deleted file mode 100644 index 6b0e054ff1eb3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) - -## HttpRequestInit interface - -Fetch API options available to [HttpHandler](./kibana-plugin-core-public.httphandler.md)s. - -Signature: - -```typescript -export interface HttpRequestInit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.httprequestinit.body.md) | BodyInit \| null | (Optional) A BodyInit object or null to set request's body. | -| [cache?](./kibana-plugin-core-public.httprequestinit.cache.md) | RequestCache | (Optional) The cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. | -| [credentials?](./kibana-plugin-core-public.httprequestinit.credentials.md) | RequestCredentials | (Optional) The credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. | -| [headers?](./kibana-plugin-core-public.httprequestinit.headers.md) | HttpHeadersInit | (Optional) [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) | -| [integrity?](./kibana-plugin-core-public.httprequestinit.integrity.md) | string | (Optional) Subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. | -| [keepalive?](./kibana-plugin-core-public.httprequestinit.keepalive.md) | boolean | (Optional) Whether or not request can outlive the global in which it was created. | -| [method?](./kibana-plugin-core-public.httprequestinit.method.md) | string | (Optional) HTTP method, which is "GET" by default. | -| [mode?](./kibana-plugin-core-public.httprequestinit.mode.md) | RequestMode | (Optional) The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. | -| [redirect?](./kibana-plugin-core-public.httprequestinit.redirect.md) | RequestRedirect | (Optional) The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. | -| [referrer?](./kibana-plugin-core-public.httprequestinit.referrer.md) | string | (Optional) The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made. | -| [referrerPolicy?](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) | ReferrerPolicy | (Optional) The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. | -| [signal?](./kibana-plugin-core-public.httprequestinit.signal.md) | AbortSignal \| null | (Optional) Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. | -| [window?](./kibana-plugin-core-public.httprequestinit.window.md) | null | (Optional) Can only be null. Used to disassociate request from any Window. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md deleted file mode 100644 index f650c32f70701..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [method](./kibana-plugin-core-public.httprequestinit.method.md) - -## HttpRequestInit.method property - -HTTP method, which is "GET" by default. - -Signature: - -```typescript -method?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md deleted file mode 100644 index 4617b02c67420..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.mode.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [mode](./kibana-plugin-core-public.httprequestinit.mode.md) - -## HttpRequestInit.mode property - -The mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. - -Signature: - -```typescript -mode?: RequestMode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md deleted file mode 100644 index f1ae55f77f133..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.redirect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [redirect](./kibana-plugin-core-public.httprequestinit.redirect.md) - -## HttpRequestInit.redirect property - -The redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. - -Signature: - -```typescript -redirect?: RequestRedirect; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md deleted file mode 100644 index 19c0435742a91..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [referrer](./kibana-plugin-core-public.httprequestinit.referrer.md) - -## HttpRequestInit.referrer property - -The referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. - -Signature: - -```typescript -referrer?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md deleted file mode 100644 index 30fc275ebf6bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.referrerpolicy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [referrerPolicy](./kibana-plugin-core-public.httprequestinit.referrerpolicy.md) - -## HttpRequestInit.referrerPolicy property - -The referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. - -Signature: - -```typescript -referrerPolicy?: ReferrerPolicy; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md deleted file mode 100644 index 8f309e7b877dc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.signal.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [signal](./kibana-plugin-core-public.httprequestinit.signal.md) - -## HttpRequestInit.signal property - -Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler. - -Signature: - -```typescript -signal?: AbortSignal | null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md b/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md deleted file mode 100644 index 6bafc9a03da58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httprequestinit.window.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) > [window](./kibana-plugin-core-public.httprequestinit.window.md) - -## HttpRequestInit.window property - -Can only be null. Used to disassociate request from any Window. - -Signature: - -```typescript -window?: null; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md deleted file mode 100644 index 5d2cb693f63e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [body](./kibana-plugin-core-public.httpresponse.body.md) - -## HttpResponse.body property - -Parsed body received, may be undefined if there was an error. - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md deleted file mode 100644 index 19e74f0da9fba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.fetchoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) - -## HttpResponse.fetchOptions property - -The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. - -Signature: - -```typescript -readonly fetchOptions: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.md deleted file mode 100644 index c0a3644ecaf2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) - -## HttpResponse interface - - -Signature: - -```typescript -export interface HttpResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.httpresponse.body.md) | TResponseBody | (Optional) Parsed body received, may be undefined if there was an error. | -| [fetchOptions](./kibana-plugin-core-public.httpresponse.fetchoptions.md) | Readonly<HttpFetchOptionsWithPath> | The original [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) used to send this request. | -| [request](./kibana-plugin-core-public.httpresponse.request.md) | Readonly<Request> | Raw request sent to Kibana server. | -| [response?](./kibana-plugin-core-public.httpresponse.response.md) | Readonly<Response> | (Optional) Raw response received, may be undefined if there was an error. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md deleted file mode 100644 index c21b0035835ba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [request](./kibana-plugin-core-public.httpresponse.request.md) - -## HttpResponse.request property - -Raw request sent to Kibana server. - -Signature: - -```typescript -readonly request: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md b/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md deleted file mode 100644 index 519412d2f4e46..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpresponse.response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpResponse](./kibana-plugin-core-public.httpresponse.md) > [response](./kibana-plugin-core-public.httpresponse.response.md) - -## HttpResponse.response property - -Raw response received, may be undefined if there was an error. - -Signature: - -```typescript -readonly response?: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md deleted file mode 100644 index 7962772dbaa5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.addloadingcountsource.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [addLoadingCountSource](./kibana-plugin-core-public.httpsetup.addloadingcountsource.md) - -## HttpSetup.addLoadingCountSource() method - -Adds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are more than 0. - -Signature: - -```typescript -addLoadingCountSource(countSource$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| countSource$ | Observable<number> | an Observable to subscribe to for loading count updates. | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md deleted file mode 100644 index d640755f8174c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.anonymouspaths.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) - -## HttpSetup.anonymousPaths property - -APIs for denoting certain paths for not requiring authentication - -Signature: - -```typescript -anonymousPaths: IAnonymousPaths; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md deleted file mode 100644 index 15206a7ae5e1d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) - -## HttpSetup.basePath property - -APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md deleted file mode 100644 index 972af2fb55044..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.delete.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [delete](./kibana-plugin-core-public.httpsetup.delete.md) - -## HttpSetup.delete property - -Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -delete: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md deleted file mode 100644 index b26c9d371e496..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.externalurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) - -## HttpSetup.externalUrl property - -Signature: - -```typescript -externalUrl: IExternalUrl; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md deleted file mode 100644 index ad232598b71ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.fetch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) - -## HttpSetup.fetch property - -Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -fetch: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md deleted file mode 100644 index 99b5d42643b59..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [get](./kibana-plugin-core-public.httpsetup.get.md) - -## HttpSetup.get property - -Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -get: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md deleted file mode 100644 index e10278470f542..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.getloadingcount_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [getLoadingCount$](./kibana-plugin-core-public.httpsetup.getloadingcount_.md) - -## HttpSetup.getLoadingCount$() method - -Get the sum of all loading count sources as a single Observable. - -Signature: - -```typescript -getLoadingCount$(): Observable; -``` -Returns: - -Observable<number> - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md deleted file mode 100644 index 07faeae2a9c0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.head.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [head](./kibana-plugin-core-public.httpsetup.head.md) - -## HttpSetup.head property - -Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -head: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md deleted file mode 100644 index 27962d3c3867b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.intercept.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [intercept](./kibana-plugin-core-public.httpsetup.intercept.md) - -## HttpSetup.intercept() method - -Adds a new [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) to the global HTTP client. - -Signature: - -```typescript -intercept(interceptor: HttpInterceptor): () => void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| interceptor | HttpInterceptor | a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) | - -Returns: - -() => void - -a function for removing the attached interceptor. - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.md deleted file mode 100644 index 2d8116b0eeba6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -## HttpSetup interface - - -Signature: - -```typescript -export interface HttpSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [anonymousPaths](./kibana-plugin-core-public.httpsetup.anonymouspaths.md) | IAnonymousPaths | APIs for denoting certain paths for not requiring authentication | -| [basePath](./kibana-plugin-core-public.httpsetup.basepath.md) | IBasePath | APIs for manipulating the basePath on URL segments. See [IBasePath](./kibana-plugin-core-public.ibasepath.md) | -| [delete](./kibana-plugin-core-public.httpsetup.delete.md) | HttpHandler | Makes an HTTP request with the DELETE method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [externalUrl](./kibana-plugin-core-public.httpsetup.externalurl.md) | IExternalUrl | | -| [fetch](./kibana-plugin-core-public.httpsetup.fetch.md) | HttpHandler | Makes an HTTP request. Defaults to a GET request unless overridden. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [get](./kibana-plugin-core-public.httpsetup.get.md) | HttpHandler | Makes an HTTP request with the GET method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [head](./kibana-plugin-core-public.httpsetup.head.md) | HttpHandler | Makes an HTTP request with the HEAD method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [options](./kibana-plugin-core-public.httpsetup.options.md) | HttpHandler | Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [patch](./kibana-plugin-core-public.httpsetup.patch.md) | HttpHandler | Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [post](./kibana-plugin-core-public.httpsetup.post.md) | HttpHandler | Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | -| [put](./kibana-plugin-core-public.httpsetup.put.md) | HttpHandler | Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. | - -## Methods - -| Method | Description | -| --- | --- | -| [addLoadingCountSource(countSource$)](./kibana-plugin-core-public.httpsetup.addloadingcountsource.md) | Adds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are more than 0. | -| [getLoadingCount$()](./kibana-plugin-core-public.httpsetup.getloadingcount_.md) | Get the sum of all loading count sources as a single Observable. | -| [intercept(interceptor)](./kibana-plugin-core-public.httpsetup.intercept.md) | Adds a new [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) to the global HTTP client. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md deleted file mode 100644 index 9a83abcae0323..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [options](./kibana-plugin-core-public.httpsetup.options.md) - -## HttpSetup.options property - -Makes an HTTP request with the OPTIONS method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -options: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md deleted file mode 100644 index 9024a12d527c2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.patch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [patch](./kibana-plugin-core-public.httpsetup.patch.md) - -## HttpSetup.patch property - -Makes an HTTP request with the PATCH method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -patch: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md deleted file mode 100644 index fd30981a0ec56..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.post.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [post](./kibana-plugin-core-public.httpsetup.post.md) - -## HttpSetup.post property - -Makes an HTTP request with the POST method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -post: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md b/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md deleted file mode 100644 index 599db3e61f504..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpsetup.put.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpSetup](./kibana-plugin-core-public.httpsetup.md) > [put](./kibana-plugin-core-public.httpsetup.put.md) - -## HttpSetup.put property - -Makes an HTTP request with the PUT method. See [HttpHandler](./kibana-plugin-core-public.httphandler.md) for options. - -Signature: - -```typescript -put: HttpHandler; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.httpstart.md b/docs/development/core/public/kibana-plugin-core-public.httpstart.md deleted file mode 100644 index 4cbbf6f07a2cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.httpstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpStart](./kibana-plugin-core-public.httpstart.md) - -## HttpStart type - -See [HttpSetup](./kibana-plugin-core-public.httpsetup.md) - -Signature: - -```typescript -export declare type HttpStart = HttpSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md b/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md deleted file mode 100644 index a0fba28be9681..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.i18nstart.context.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [I18nStart](./kibana-plugin-core-public.i18nstart.md) > [Context](./kibana-plugin-core-public.i18nstart.context.md) - -## I18nStart.Context property - -React Context provider required as the topmost component for any i18n-compatible React tree. - -Signature: - -```typescript -Context: ({ children }: { - children: React.ReactNode; - }) => JSX.Element; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.i18nstart.md b/docs/development/core/public/kibana-plugin-core-public.i18nstart.md deleted file mode 100644 index 586f5797abe6c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.i18nstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [I18nStart](./kibana-plugin-core-public.i18nstart.md) - -## I18nStart interface - -I18nStart.Context is required by any localizable React component from @kbn/i18n and @elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. - -Signature: - -```typescript -export interface I18nStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [Context](./kibana-plugin-core-public.i18nstart.context.md) | ({ children }: { children: React.ReactNode; }) => JSX.Element | React Context provider required as the topmost component for any i18n-compatible React tree. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md deleted file mode 100644 index 115285c84ea78..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.isanonymous.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) > [isAnonymous](./kibana-plugin-core-public.ianonymouspaths.isanonymous.md) - -## IAnonymousPaths.isAnonymous() method - -Determines whether the provided path doesn't require authentication. `path` should include the current basePath. - -Signature: - -```typescript -isAnonymous(path: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md deleted file mode 100644 index 91d66206dd9ee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) - -## IAnonymousPaths interface - -APIs for denoting paths as not requiring authentication - -Signature: - -```typescript -export interface IAnonymousPaths -``` - -## Methods - -| Method | Description | -| --- | --- | -| [isAnonymous(path)](./kibana-plugin-core-public.ianonymouspaths.isanonymous.md) | Determines whether the provided path doesn't require authentication. path should include the current basePath. | -| [register(path)](./kibana-plugin-core-public.ianonymouspaths.register.md) | Register path as not requiring authentication. path should not include the current basePath. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md b/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md deleted file mode 100644 index bfcc0f6decd5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ianonymouspaths.register.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) > [register](./kibana-plugin-core-public.ianonymouspaths.register.md) - -## IAnonymousPaths.register() method - -Register `path` as not requiring authentication. `path` should not include the current basePath. - -Signature: - -```typescript -register(path: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md deleted file mode 100644 index ed27de777b715..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [get](./kibana-plugin-core-public.ibasepath.get.md) - -## IBasePath.get property - -Gets the `basePath` string. - -Signature: - -```typescript -get: () => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.md deleted file mode 100644 index 72a863f7d515c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) - -## IBasePath interface - -APIs for manipulating the basePath on URL segments. - -Signature: - -```typescript -export interface IBasePath -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-public.ibasepath.get.md) | () => string | Gets the basePath string. | -| [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | (url: string) => string | Prepends path with the basePath. | -| [publicBaseUrl?](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). | -| [remove](./kibana-plugin-core-public.ibasepath.remove.md) | (url: string) => string | Removes the prepended basePath from the path. | -| [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | string | Returns the server's root basePath as configured, without any namespace prefix.See for getting the basePath value for a specific request | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md deleted file mode 100644 index b3e55351d350f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.prepend.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) - -## IBasePath.prepend property - -Prepends `path` with the basePath. - -Signature: - -```typescript -prepend: (url: string) => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md deleted file mode 100644 index f45cc6eba2959..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [publicBaseUrl](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) - -## IBasePath.publicBaseUrl property - -The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md). - -Signature: - -```typescript -readonly publicBaseUrl?: string; -``` - -## Remarks - -Should be used for generating external URL links back to this Kibana instance. - diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md deleted file mode 100644 index 2fcbe487e95b3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [remove](./kibana-plugin-core-public.ibasepath.remove.md) - -## IBasePath.remove property - -Removes the prepended basePath from the `path`. - -Signature: - -```typescript -remove: (url: string) => string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md b/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md deleted file mode 100644 index f800b792e7b7f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ibasepath.serverbasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IBasePath](./kibana-plugin-core-public.ibasepath.md) > [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) - -## IBasePath.serverBasePath property - -Returns the server's root basePath as configured, without any namespace prefix. - -See for getting the basePath value for a specific request - -Signature: - -```typescript -readonly serverBasePath: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md deleted file mode 100644 index 396e5586f1fed..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.isinternalurl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) > [isInternalUrl](./kibana-plugin-core-public.iexternalurl.isinternalurl.md) - -## IExternalUrl.isInternalUrl() method - -Determines if the provided URL is an internal url. - -Signature: - -```typescript -isInternalUrl(relativeOrAbsoluteUrl: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| relativeOrAbsoluteUrl | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md deleted file mode 100644 index d0d4e6a3a4464..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) - -## IExternalUrl interface - -APIs for working with external URLs. - -Signature: - -```typescript -export interface IExternalUrl -``` - -## Methods - -| Method | Description | -| --- | --- | -| [isInternalUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.isinternalurl.md) | Determines if the provided URL is an internal url. | -| [validateUrl(relativeOrAbsoluteUrl)](./kibana-plugin-core-public.iexternalurl.validateurl.md) | Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml.If the URL is valid, then a URL will be returned. Otherwise, this will return null. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md deleted file mode 100644 index 24140effc45d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurl.validateurl.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) > [validateUrl](./kibana-plugin-core-public.iexternalurl.validateurl.md) - -## IExternalUrl.validateUrl() method - -Determines if the provided URL is a valid location to send users. Validation is based on the configured allow list in kibana.yml. - -If the URL is valid, then a URL will be returned. Otherwise, this will return null. - -Signature: - -```typescript -validateUrl(relativeOrAbsoluteUrl: string): URL | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| relativeOrAbsoluteUrl | string | | - -Returns: - -URL \| null - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md deleted file mode 100644 index ec7129a43b99a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.allow.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) - -## IExternalUrlPolicy.allow property - -Indicates if this policy allows or denies access to the described destination. - -Signature: - -```typescript -allow: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md deleted file mode 100644 index 1d3c9fc9bbaf1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.host.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) - -## IExternalUrlPolicy.host property - -Optional host describing the external destination. May be combined with `protocol`. - -Signature: - -```typescript -host?: string; -``` - -## Example - - -```ts -// allows access to all of google.com, using any protocol. -allow: true, -host: 'google.com' -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md deleted file mode 100644 index 6623fec18d976..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) - -## IExternalUrlPolicy interface - -A policy describing whether access to an external destination is allowed. - -Signature: - -```typescript -export interface IExternalUrlPolicy -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. | -| [host?](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined with protocol. | -| [protocol?](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md b/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md deleted file mode 100644 index 6b6f8b9638bb8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iexternalurlpolicy.protocol.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) - -## IExternalUrlPolicy.protocol property - -Optional protocol describing the external destination. May be combined with `host`. - -Signature: - -```typescript -protocol?: string; -``` - -## Example - - -```ts -// allows access to all destinations over the `https` protocol. -allow: true, -protocol: 'https' -``` - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md deleted file mode 100644 index d053a5a9d360c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.body.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [body](./kibana-plugin-core-public.ihttpfetcherror.body.md) - -## IHttpFetchError.body property - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md deleted file mode 100644 index 9aaae1be72028..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) - -## IHttpFetchError interface - - -Signature: - -```typescript -export interface IHttpFetchError extends Error -``` -Extends: Error - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.ihttpfetcherror.body.md) | TResponseBody | (Optional) | -| [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) | string | | -| [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) | Request | | -| [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) | Request | | -| [res?](./kibana-plugin-core-public.ihttpfetcherror.res.md) | Response | (Optional) | -| [response?](./kibana-plugin-core-public.ihttpfetcherror.response.md) | Response | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md deleted file mode 100644 index 4ab1ddd4b90ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [name](./kibana-plugin-core-public.ihttpfetcherror.name.md) - -## IHttpFetchError.name property - -Signature: - -```typescript -readonly name: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md deleted file mode 100644 index eb1c158156e5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.req.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [req](./kibana-plugin-core-public.ihttpfetcherror.req.md) - -## IHttpFetchError.req property - -> Warning: This API is now obsolete. -> -> Provided for legacy compatibility. Prefer the `request` property instead. 8.8.0 -> -> Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. -> - -Signature: - -```typescript -readonly req: Request; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md deleted file mode 100644 index 193d4cf92587e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [request](./kibana-plugin-core-public.ihttpfetcherror.request.md) - -## IHttpFetchError.request property - -Signature: - -```typescript -readonly request: Request; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md deleted file mode 100644 index 4440986db4ff8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.res.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [res](./kibana-plugin-core-public.ihttpfetcherror.res.md) - -## IHttpFetchError.res property - -> Warning: This API is now obsolete. -> -> Provided for legacy compatibility. Prefer the `response` property instead. 8.8.0 -> -> Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. -> - -Signature: - -```typescript -readonly res?: Response; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md deleted file mode 100644 index 1f7fcc746e19b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpfetcherror.response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) > [response](./kibana-plugin-core-public.ihttpfetcherror.response.md) - -## IHttpFetchError.response property - -Signature: - -```typescript -readonly response?: Response; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md deleted file mode 100644 index b982e4dbac8a6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halt.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) > [halt](./kibana-plugin-core-public.ihttpinterceptcontroller.halt.md) - -## IHttpInterceptController.halt() method - -Halt the request Promise chain and do not process further interceptors or response handlers. - -Signature: - -```typescript -halt(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md deleted file mode 100644 index 82e5378412a5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.halted.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) > [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) - -## IHttpInterceptController.halted property - -Whether or not this chain has been halted. - -Signature: - -```typescript -halted: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md b/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md deleted file mode 100644 index 15a66ef569e7d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpinterceptcontroller.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) - -## IHttpInterceptController interface - -Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md). - -Signature: - -```typescript -export interface IHttpInterceptController -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [halted](./kibana-plugin-core-public.ihttpinterceptcontroller.halted.md) | boolean | Whether or not this chain has been halted. | - -## Methods - -| Method | Description | -| --- | --- | -| [halt()](./kibana-plugin-core-public.ihttpinterceptcontroller.halt.md) | Halt the request Promise chain and do not process further interceptors or response handlers. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md deleted file mode 100644 index 70dfe72d62ac5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) > [body](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md) - -## IHttpResponseInterceptorOverrides.body property - -Parsed body received, may be undefined if there was an error. - -Signature: - -```typescript -readonly body?: TResponseBody; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md deleted file mode 100644 index 57a4555cd6da5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) - -## IHttpResponseInterceptorOverrides interface - -Properties that can be returned by HttpInterceptor.request to override the response. - -Signature: - -```typescript -export interface IHttpResponseInterceptorOverrides -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.body.md) | TResponseBody | (Optional) Parsed body received, may be undefined if there was an error. | -| [response?](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md) | Readonly<Response> | (Optional) Raw response received, may be undefined if there was an error. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md b/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md deleted file mode 100644 index c858200c2113f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) > [response](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.response.md) - -## IHttpResponseInterceptorOverrides.response property - -Raw response received, may be undefined if there was an error. - -Signature: - -```typescript -readonly response?: Readonly; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.itoasts.md b/docs/development/core/public/kibana-plugin-core-public.itoasts.md deleted file mode 100644 index e009c77fe23bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.itoasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IToasts](./kibana-plugin-core-public.itoasts.md) - -## IToasts type - -Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-core-public.toastsapi.md). - -Signature: - -```typescript -export declare type IToasts = Pick; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md deleted file mode 100644 index 903b6ff4bad1f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [get](./kibana-plugin-core-public.iuisettingsclient.get.md) - -## IUiSettingsClient.get property - -Gets the value for a specific uiSetting. If this setting has no user-defined value then the `defaultOverride` parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. - -Signature: - -```typescript -get: (key: string, defaultOverride?: T) => T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md deleted file mode 100644 index 2ba20c34e81a5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.get_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) - -## IUiSettingsClient.get$ property - -Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a `defaultOverride` argument behaves the same as it does in \#get() - -Signature: - -```typescript -get$: (key: string, defaultOverride?: T) => Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md deleted file mode 100644 index 004979977376e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getall.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) - -## IUiSettingsClient.getAll property - -Gets the metadata about all uiSettings, including the type, default value, and user value for each key. - -Signature: - -```typescript -getAll: () => Readonly>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md deleted file mode 100644 index e9a8bf7cceece..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdate_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) - -## IUiSettingsClient.getUpdate$ property - -Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. - -Signature: - -```typescript -getUpdate$: () => Observable<{ - key: string; - newValue: T; - oldValue: T; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md deleted file mode 100644 index 6270f4b553434..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [getUpdateErrors$](./kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md) - -## IUiSettingsClient.getUpdateErrors$ property - -Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. - -Signature: - -```typescript -getUpdateErrors$: () => Observable; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md deleted file mode 100644 index 8d3b2d9d37139..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.iscustom.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) - -## IUiSettingsClient.isCustom property - -Returns true if the setting wasn't registered by any plugin, but was either added directly via `set()`, or is an unknown setting found in the uiSettings saved object - -Signature: - -```typescript -isCustom: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md deleted file mode 100644 index 39c8a32202691..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdeclared.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) - -## IUiSettingsClient.isDeclared property - -Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the `set()` method. - -Signature: - -```typescript -isDeclared: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md deleted file mode 100644 index 4a1b948bf0aca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isdefault.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) - -## IUiSettingsClient.isDefault property - -Returns true if the setting has no user-defined value or is unknown - -Signature: - -```typescript -isDefault: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md deleted file mode 100644 index 0684c3617e434..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.isoverridden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) - -## IUiSettingsClient.isOverridden property - -Shows whether the uiSettings value set by the user. - -Signature: - -```typescript -isOverridden: (key: string) => boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md deleted file mode 100644 index 5d2429a799fe6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -## IUiSettingsClient interface - -Client-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) - -Signature: - -```typescript -export interface IUiSettingsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-public.iuisettingsclient.get.md) | <T = any>(key: string, defaultOverride?: T) => T | Gets the value for a specific uiSetting. If this setting has no user-defined value then the defaultOverride parameter is returned (and parsed if setting is of type "json" or "number). If the parameter is not defined and the key is not registered by any plugin then an error is thrown, otherwise reads the default value defined by a plugin. | -| [get$](./kibana-plugin-core-public.iuisettingsclient.get_.md) | <T = any>(key: string, defaultOverride?: T) => Observable<T> | Gets an observable of the current value for a config key, and all updates to that config key in the future. Providing a defaultOverride argument behaves the same as it does in \#get() | -| [getAll](./kibana-plugin-core-public.iuisettingsclient.getall.md) | () => Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>> | Gets the metadata about all uiSettings, including the type, default value, and user value for each key. | -| [getUpdate$](./kibana-plugin-core-public.iuisettingsclient.getupdate_.md) | <T = any>() => Observable<{ key: string; newValue: T; oldValue: T; }> | Returns an Observable that notifies subscribers of each update to the uiSettings, including the key, newValue, and oldValue of the setting that changed. | -| [getUpdateErrors$](./kibana-plugin-core-public.iuisettingsclient.getupdateerrors_.md) | () => Observable<Error> | Returns an Observable that notifies subscribers of each error while trying to update the settings, containing the actual Error class. | -| [isCustom](./kibana-plugin-core-public.iuisettingsclient.iscustom.md) | (key: string) => boolean | Returns true if the setting wasn't registered by any plugin, but was either added directly via set(), or is an unknown setting found in the uiSettings saved object | -| [isDeclared](./kibana-plugin-core-public.iuisettingsclient.isdeclared.md) | (key: string) => boolean | Returns true if the key is a "known" uiSetting, meaning it is either registered by any plugin or was previously added as a custom setting via the set() method. | -| [isDefault](./kibana-plugin-core-public.iuisettingsclient.isdefault.md) | (key: string) => boolean | Returns true if the setting has no user-defined value or is unknown | -| [isOverridden](./kibana-plugin-core-public.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. | -| [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) | (key: string) => Promise<boolean> | Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling set(key, null), including the synchronization, custom setting, and error behavior of that method. | -| [set](./kibana-plugin-core-public.iuisettingsclient.set.md) | (key: string, value: any) => Promise<boolean> | Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the get() method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before set() was called. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md deleted file mode 100644 index b6d4ff04cf4a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [remove](./kibana-plugin-core-public.iuisettingsclient.remove.md) - -## IUiSettingsClient.remove property - -Removes the user-defined value for a setting, causing it to revert to the default. This method behaves the same as calling `set(key, null)`, including the synchronization, custom setting, and error behavior of that method. - -Signature: - -```typescript -remove: (key: string) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md b/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md deleted file mode 100644 index ea817c39980ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.iuisettingsclient.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) > [set](./kibana-plugin-core-public.iuisettingsclient.set.md) - -## IUiSettingsClient.set property - -Sets the value for a uiSetting. If the setting is not registered by any plugin it will be stored as a custom setting. The new value will be synchronously available via the `get()` method and sent to the server in the background. If the request to the server fails then a updateErrors$ will be notified and the setting will be reverted to its value before `set()` was called. - -Signature: - -```typescript -set: (key: string, value: any) => Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md b/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md deleted file mode 100644 index d8f8a77d84b2f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) - -## KibanaExecutionContext type - -Represents a meta-information about a Kibana entity initiating a search request. - -Signature: - -```typescript -export declare type KibanaExecutionContext = { - readonly type?: string; - readonly name?: string; - readonly page?: string; - readonly id?: string; - readonly description?: string; - readonly url?: string; - child?: KibanaExecutionContext; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.md b/docs/development/core/public/kibana-plugin-core-public.md deleted file mode 100644 index 1d2b07d13f6a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.md +++ /dev/null @@ -1,185 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) - -## kibana-plugin-core-public package - -The Kibana Core APIs for client-side plugins. - -A plugin's `public/index` file must contain a named import, `plugin`, that implements [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) which returns an object that implements . - -The plugin integrates with the core system via lifecycle events: `setup`, `start`, and `stop`. In each lifecycle method, the plugin will receive the corresponding core services available (either [CoreSetup](./kibana-plugin-core-public.coresetup.md) or [CoreStart](./kibana-plugin-core-public.corestart.md)) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. - -## Classes - -| Class | Description | -| --- | --- | -| [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) | A wrapper around a History instance that is scoped to a particular base path of the history stack. Behaves similarly to the basename option except that this wrapper hides any history stack entries from outside the scope of this base path.This wrapper also allows Core and Plugins to share a single underlying global History instance without exposing the history of other applications.The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. | -| [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md).It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. | -| [ToastsApi](./kibana-plugin-core-public.toastsapi.md) | Methods for adding and removing global toast messages. | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AppLeaveActionType](./kibana-plugin-core-public.appleaveactiontype.md) | Possible type of actions on application leave. | -| [AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md) | Status of the application's navLink. | -| [AppStatus](./kibana-plugin-core-public.appstatus.md) | Accessibility status of an application. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [App](./kibana-plugin-core-public.app.md) | | -| [AppCategory](./kibana-plugin-core-public.appcategory.md) | A category definition for nav links to know where to sort them in the left hand nav | -| [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to show a confirmation message when trying to leave an application.See | -| [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) | Action to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) to execute the default behaviour when leaving the application.See | -| [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | | -| [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | | -| [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) | | -| [AppNavOptions](./kibana-plugin-core-public.appnavoptions.md) | App navigation menu options | -| [Capabilities](./kibana-plugin-core-public.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. | -| [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) | | -| [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) | APIs for accessing and updating the document title. | -| [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) | | -| [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) | | -| [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) | | -| [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) | | -| [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) | | -| [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) | | -| [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) | | -| [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. | -| [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) | | -| [ChromeNavLinks](./kibana-plugin-core-public.chromenavlinks.md) | [APIs](./kibana-plugin-core-public.chromenavlinks.md) for manipulating nav links. | -| [ChromeRecentlyAccessed](./kibana-plugin-core-public.chromerecentlyaccessed.md) | [APIs](./kibana-plugin-core-public.chromerecentlyaccessed.md) for recently accessed history. | -| [ChromeRecentlyAccessedHistoryItem](./kibana-plugin-core-public.chromerecentlyaccessedhistoryitem.md) | | -| [ChromeStart](./kibana-plugin-core-public.chromestart.md) | ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. | -| [ChromeUserBanner](./kibana-plugin-core-public.chromeuserbanner.md) | | -| [CoreSetup](./kibana-plugin-core-public.coresetup.md) | Core services exposed to the Plugin setup lifecycle | -| [CoreStart](./kibana-plugin-core-public.corestart.md) | Core services exposed to the Plugin start lifecycle | -| [DeprecationsServiceStart](./kibana-plugin-core-public.deprecationsservicestart.md) | DeprecationsService provides methods to fetch domain deprecation details from the Kibana server. | -| [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) error APIs. | -| [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md) | Kibana execution context. Used to provide execution context to Elasticsearch, reporting, performance monitoring, etc. | -| [FatalErrorInfo](./kibana-plugin-core-public.fatalerrorinfo.md) | Represents the message and stack of a fatal Error | -| [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. | -| [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) | All options that may be used with a [HttpHandler](./kibana-plugin-core-public.httphandler.md). | -| [HttpFetchOptionsWithPath](./kibana-plugin-core-public.httpfetchoptionswithpath.md) | Similar to [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) but with the URL path included. | -| [HttpFetchQuery](./kibana-plugin-core-public.httpfetchquery.md) | | -| [HttpHandler](./kibana-plugin-core-public.httphandler.md) | A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) for options and [HttpResponse](./kibana-plugin-core-public.httpresponse.md) for the response. | -| [HttpHeadersInit](./kibana-plugin-core-public.httpheadersinit.md) | Headers to append to the request. Any headers that begin with kbn- are considered private to Core and will cause [HttpHandler](./kibana-plugin-core-public.httphandler.md) to throw an error. | -| [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md) | An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md). | -| [HttpInterceptorRequestError](./kibana-plugin-core-public.httpinterceptorrequesterror.md) | | -| [HttpInterceptorResponseError](./kibana-plugin-core-public.httpinterceptorresponseerror.md) | | -| [HttpRequestInit](./kibana-plugin-core-public.httprequestinit.md) | Fetch API options available to [HttpHandler](./kibana-plugin-core-public.httphandler.md)s. | -| [HttpResponse](./kibana-plugin-core-public.httpresponse.md) | | -| [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | | -| [I18nStart](./kibana-plugin-core-public.i18nstart.md) | I18nStart.Context is required by any localizable React component from @kbn/i18n and @elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. | -| [IAnonymousPaths](./kibana-plugin-core-public.ianonymouspaths.md) | APIs for denoting paths as not requiring authentication | -| [IBasePath](./kibana-plugin-core-public.ibasepath.md) | APIs for manipulating the basePath on URL segments. | -| [IExternalUrl](./kibana-plugin-core-public.iexternalurl.md) | APIs for working with external URLs. | -| [IExternalUrlPolicy](./kibana-plugin-core-public.iexternalurlpolicy.md) | A policy describing whether access to an external destination is allowed. | -| [IHttpFetchError](./kibana-plugin-core-public.ihttpfetcherror.md) | | -| [IHttpInterceptController](./kibana-plugin-core-public.ihttpinterceptcontroller.md) | Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-core-public.httpinterceptor.md). | -| [IHttpResponseInterceptorOverrides](./kibana-plugin-core-public.ihttpresponseinterceptoroverrides.md) | Properties that can be returned by HttpInterceptor.request to override the response. | -| [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | Client-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) | -| [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) | Options for the [navigateToApp API](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) | -| [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) | Options for the [navigateToUrl API](./kibana-plugin-core-public.applicationstart.navigatetourl.md) | -| [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) | | -| [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) | | -| [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) | | -| [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) | | -| [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) | APIs to open and manage fly-out dialogs. | -| [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) | | -| [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) | | -| [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) | APIs to open and manage modal dialogs. | -| [OverlayRef](./kibana-plugin-core-public.overlayref.md) | Returned by [OverlayStart](./kibana-plugin-core-public.overlaystart.md) methods for closing a mounted overlay. | -| [OverlayStart](./kibana-plugin-core-public.overlaystart.md) | | -| [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) | The interface that should be returned by a PluginInitializer. | -| [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) | The available core services passed to a PluginInitializer | -| [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) | This interface is a very simple wrapper for SavedObjects resolved from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). | -| [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) | | -| [SavedObject](./kibana-plugin-core-public.savedobject.md) | | -| [SavedObjectAttributes](./kibana-plugin-core-public.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the attributes property. | -| [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) | | -| [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) | A reference to another saved object. | -| [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) | A returned input object or one of its references, with additional context. | -| [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) | | -| [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) | | -| [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) | | -| [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) | | -| [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) | | -| [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) | | -| [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) | | -| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) | | -| [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) | The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. | -| [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) | The response when object references are collected. | -| [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) | | -| [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) | | -| [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) | | -| [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects find() method.\*Note\*: this type is different between the Public and Server Saved Objects clients. | -| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) | A warning meant to notify that a specific user action is required to finalize the import of some type of object. The actionUrl must be a path relative to the basePath, and not include it. | -| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. | -| [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. | -| [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) | Represents a failure to import. | -| [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. | -| [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) | The response describing the result of an import. | -| [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. | -| [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) | A simple informative warning that will be displayed to the user. | -| [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) | Represents a successful import. | -| [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. | -| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. | -| [SavedObjectsMigrationVersion](./kibana-plugin-core-public.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) | | -| [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) | | -| [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) | | -| [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. | -| [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) | UiSettings parameters defined by the plugins. | -| [UiSettingsState](./kibana-plugin-core-public.uisettingsstate.md) | | -| [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) | Describes the values explicitly set by user. | - -## Variables - -| Variable | Description | -| --- | --- | -| [APP\_WRAPPER\_CLASS](./kibana-plugin-core-public.app_wrapper_class.md) | The class name for top level \*and\* nested application wrappers to ensure proper layout | -| [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md) | The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) | Input type for registering secondary in-app locations for an application.Deep links must include at least one of path or deepLinks. A deep link that does not have a path represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | -| [AppLeaveAction](./kibana-plugin-core-public.appleaveaction.md) | Possible actions to return from a [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md)See [AppLeaveConfirmAction](./kibana-plugin-core-public.appleaveconfirmaction.md) and [AppLeaveDefaultAction](./kibana-plugin-core-public.appleavedefaultaction.md) | -| [AppLeaveHandler](./kibana-plugin-core-public.appleavehandler.md) | A handler that will be executed before leaving the application, either when going to another application or when closing the browser tab or manually changing the url. Should return confirm to prompt a message to the user before leaving the page, or default to keep the default behavior (doing nothing).See [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) for detailed usage examples. | -| [AppMount](./kibana-plugin-core-public.appmount.md) | A mount function called when the user navigates to this app's route. | -| [AppUnmount](./kibana-plugin-core-public.appunmount.md) | A function called when an application should be unmounted from the page. This function should be synchronous. | -| [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) | Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md). | -| [AppUpdater](./kibana-plugin-core-public.appupdater.md) | Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) | -| [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md) | | -| [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) | | -| [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) | | -| [ExecutionContextStart](./kibana-plugin-core-public.executioncontextstart.md) | See [ExecutionContextSetup](./kibana-plugin-core-public.executioncontextsetup.md). | -| [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. | -| [HttpStart](./kibana-plugin-core-public.httpstart.md) | See [HttpSetup](./kibana-plugin-core-public.httpsetup.md) | -| [IToasts](./kibana-plugin-core-public.itoasts.md) | Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-core-public.toastsapi.md). | -| [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) | Represents a meta-information about a Kibana entity initiating a search request. | -| [MountPoint](./kibana-plugin-core-public.mountpoint.md) | A function that should mount DOM content inside the provided container element and return a handler to unmount it. | -| [NavType](./kibana-plugin-core-public.navtype.md) | | -| [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) | The plugin export at the root of a plugin's public directory should conform to this interface. | -| [PublicAppDeepLinkInfo](./kibana-plugin-core-public.publicappdeeplinkinfo.md) | Public information about a registered app's [deepLinks](./kibana-plugin-core-public.appdeeplink.md) | -| [PublicAppInfo](./kibana-plugin-core-public.publicappinfo.md) | Public information about a registered [application](./kibana-plugin-core-public.app.md) | -| [PublicUiSettingsParams](./kibana-plugin-core-public.publicuisettingsparams.md) | A sub-set of [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) exposed to the client-side. | -| [ResolveDeprecationResponse](./kibana-plugin-core-public.resolvedeprecationresponse.md) | | -| [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | Type definition for a Saved Object attribute value | -| [SavedObjectAttributeSingle](./kibana-plugin-core-public.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) | -| [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) | Composite type of all the possible types of import warnings.See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details. | -| [SavedObjectsNamespaceType](./kibana-plugin-core-public.savedobjectsnamespacetype.md) | The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. | -| [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers, such as [App.mount](./kibana-plugin-core-public.app.mount.md). Promise will not resolve until Core and plugin dependencies have completed start. | -| [Toast](./kibana-plugin-core-public.toast.md) | | -| [ToastInput](./kibana-plugin-core-public.toastinput.md) | Inputs for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. | -| [ToastInputFields](./kibana-plugin-core-public.toastinputfields.md) | Allowed fields for [ToastInput](./kibana-plugin-core-public.toastinput.md). | -| [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) | [IToasts](./kibana-plugin-core-public.itoasts.md) | -| [ToastsStart](./kibana-plugin-core-public.toastsstart.md) | [IToasts](./kibana-plugin-core-public.itoasts.md) | -| [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) | UI element type to represent the settings. | -| [UnmountCallback](./kibana-plugin-core-public.unmountcallback.md) | A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-core-public.mountpoint.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md b/docs/development/core/public/kibana-plugin-core-public.mountpoint.md deleted file mode 100644 index 41c6269b3e6da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.mountpoint.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [MountPoint](./kibana-plugin-core-public.mountpoint.md) - -## MountPoint type - -A function that should mount DOM content inside the provided container element and return a handler to unmount it. - -Signature: - -```typescript -export declare type MountPoint = (element: T) => UnmountCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md deleted file mode 100644 index 4039e1338fc1c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [deepLinkId](./kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md) - -## NavigateToAppOptions.deepLinkId property - -optional [deep link](./kibana-plugin-core-public.app.deeplinks.md) id inside the application to navigate to. If an additional [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) is defined it will be appended to the deep link path. - -Signature: - -```typescript -deepLinkId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md deleted file mode 100644 index 337e9db1f80d2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) - -## NavigateToAppOptions interface - -Options for the [navigateToApp API](./kibana-plugin-core-public.applicationstart.navigatetoapp.md) - -Signature: - -```typescript -export interface NavigateToAppOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deepLinkId?](./kibana-plugin-core-public.navigatetoappoptions.deeplinkid.md) | string | (Optional) optional [deep link](./kibana-plugin-core-public.app.deeplinks.md) id inside the application to navigate to. If an additional [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) is defined it will be appended to the deep link path. | -| [openInNewTab?](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) | boolean | (Optional) if true, will open the app in new tab, will share session information via window.open if base | -| [path?](./kibana-plugin-core-public.navigatetoappoptions.path.md) | string | (Optional) optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default. | -| [replace?](./kibana-plugin-core-public.navigatetoappoptions.replace.md) | boolean | (Optional) if true, will not create a new history entry when navigating (using replace instead of push) | -| [skipAppLeave?](./kibana-plugin-core-public.navigatetoappoptions.skipappleave.md) | boolean | (Optional) if true, will bypass the default onAppLeave behavior | -| [state?](./kibana-plugin-core-public.navigatetoappoptions.state.md) | unknown | (Optional) optional state to forward to the application | - diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md deleted file mode 100644 index 4609fa68b3824..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [openInNewTab](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md) - -## NavigateToAppOptions.openInNewTab property - -if true, will open the app in new tab, will share session information via window.open if base - -Signature: - -```typescript -openInNewTab?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md deleted file mode 100644 index b39fc8c324ad9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [path](./kibana-plugin-core-public.navigatetoappoptions.path.md) - -## NavigateToAppOptions.path property - -optional path inside application to deep link to. If undefined, will use [the app's default path](./kibana-plugin-core-public.app.defaultpath.md) as default. - -Signature: - -```typescript -path?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md deleted file mode 100644 index 8a7440025aedc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.replace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [replace](./kibana-plugin-core-public.navigatetoappoptions.replace.md) - -## NavigateToAppOptions.replace property - -if true, will not create a new history entry when navigating (using `replace` instead of `push`) - -Signature: - -```typescript -replace?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md deleted file mode 100644 index 553d557a92daa..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.skipappleave.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [skipAppLeave](./kibana-plugin-core-public.navigatetoappoptions.skipappleave.md) - -## NavigateToAppOptions.skipAppLeave property - -if true, will bypass the default onAppLeave behavior - -Signature: - -```typescript -skipAppLeave?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md b/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md deleted file mode 100644 index ccb76f7bbf18e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetoappoptions.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) > [state](./kibana-plugin-core-public.navigatetoappoptions.state.md) - -## NavigateToAppOptions.state property - -optional state to forward to the application - -Signature: - -```typescript -state?: unknown; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md deleted file mode 100644 index a71196093a9a0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.forceredirect.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) > [forceRedirect](./kibana-plugin-core-public.navigatetourloptions.forceredirect.md) - -## NavigateToUrlOptions.forceRedirect property - -if true will force a full page reload/refresh/assign, overriding the outcome of other url checks against current the location (effectively using `window.location.assign` instead of `push`) - -Signature: - -```typescript -forceRedirect?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md deleted file mode 100644 index 2ee7b4f843c67..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) - -## NavigateToUrlOptions interface - -Options for the [navigateToUrl API](./kibana-plugin-core-public.applicationstart.navigatetourl.md) - -Signature: - -```typescript -export interface NavigateToUrlOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [forceRedirect?](./kibana-plugin-core-public.navigatetourloptions.forceredirect.md) | boolean | (Optional) if true will force a full page reload/refresh/assign, overriding the outcome of other url checks against current the location (effectively using window.location.assign instead of push) | -| [skipAppLeave?](./kibana-plugin-core-public.navigatetourloptions.skipappleave.md) | boolean | (Optional) if true, will bypass the default onAppLeave behavior | - diff --git a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md b/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md deleted file mode 100644 index f3685c02ff40d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navigatetourloptions.skipappleave.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavigateToUrlOptions](./kibana-plugin-core-public.navigatetourloptions.md) > [skipAppLeave](./kibana-plugin-core-public.navigatetourloptions.skipappleave.md) - -## NavigateToUrlOptions.skipAppLeave property - -if true, will bypass the default onAppLeave behavior - -Signature: - -```typescript -skipAppLeave?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.navtype.md b/docs/development/core/public/kibana-plugin-core-public.navtype.md deleted file mode 100644 index 8f1d9a4351754..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.navtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NavType](./kibana-plugin-core-public.navtype.md) - -## NavType type - -Signature: - -```typescript -export declare type NavType = 'modern' | 'legacy'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md deleted file mode 100644 index efaeafa1afb1a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) - -## NotificationsSetup interface - - -Signature: - -```typescript -export interface NotificationsSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) | ToastsSetup | [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md deleted file mode 100644 index f544ce98989b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationssetup.toasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) > [toasts](./kibana-plugin-core-public.notificationssetup.toasts.md) - -## NotificationsSetup.toasts property - -[ToastsSetup](./kibana-plugin-core-public.toastssetup.md) - -Signature: - -```typescript -toasts: ToastsSetup; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md deleted file mode 100644 index 0e77badd51235..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) - -## NotificationsStart interface - - -Signature: - -```typescript -export interface NotificationsStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) | ToastsStart | [ToastsStart](./kibana-plugin-core-public.toastsstart.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md b/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md deleted file mode 100644 index a047c66f04e71..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.notificationsstart.toasts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) > [toasts](./kibana-plugin-core-public.notificationsstart.toasts.md) - -## NotificationsStart.toasts property - -[ToastsStart](./kibana-plugin-core-public.toastsstart.md) - -Signature: - -```typescript -toasts: ToastsStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md deleted file mode 100644 index fd3ce0b3a4292..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.add.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [add](./kibana-plugin-core-public.overlaybannersstart.add.md) - -## OverlayBannersStart.add() method - -Add a new banner - -Signature: - -```typescript -add(mount: MountPoint, priority?: number): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) | -| priority | number | optional priority order to display this banner. Higher priority values are shown first. | - -Returns: - -string - -a unique identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-core-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-core-public.overlaybannersstart.replace.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md deleted file mode 100644 index b5f0ab1d01299..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.getcomponent.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [getComponent](./kibana-plugin-core-public.overlaybannersstart.getcomponent.md) - -## OverlayBannersStart.getComponent() method - -Signature: - -```typescript -getComponent(): JSX.Element; -``` -Returns: - -JSX.Element - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md deleted file mode 100644 index f81da84d58bdc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) - -## OverlayBannersStart interface - - -Signature: - -```typescript -export interface OverlayBannersStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [add(mount, priority)](./kibana-plugin-core-public.overlaybannersstart.add.md) | Add a new banner | -| [getComponent()](./kibana-plugin-core-public.overlaybannersstart.getcomponent.md) | | -| [remove(id)](./kibana-plugin-core-public.overlaybannersstart.remove.md) | Remove a banner | -| [replace(id, mount, priority)](./kibana-plugin-core-public.overlaybannersstart.replace.md) | Replace a banner in place | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md deleted file mode 100644 index ce1e3ee08bd51..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.remove.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [remove](./kibana-plugin-core-public.overlaybannersstart.remove.md) - -## OverlayBannersStart.remove() method - -Remove a banner - -Signature: - -```typescript -remove(id: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) | - -Returns: - -boolean - -if the banner was found or not - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md b/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md deleted file mode 100644 index ea16c739cc847..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaybannersstart.replace.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) > [replace](./kibana-plugin-core-public.overlaybannersstart.replace.md) - -## OverlayBannersStart.replace() method - -Replace a banner in place - -Signature: - -```typescript -replace(id: string | undefined, mount: MountPoint, priority?: number): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string \| undefined | the unique identifier for the banner returned by [OverlayBannersStart.add()](./kibana-plugin-core-public.overlaybannersstart.add.md) | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) | -| priority | number | optional priority order to display this banner. Higher priority values are shown first. | - -Returns: - -string - -a new identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-core-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-core-public.overlaybannersstart.replace.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md deleted file mode 100644 index f135fa9618958..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > ["aria-label"](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) - -## OverlayFlyoutOpenOptions."aria-label" property - -Signature: - -```typescript -'aria-label'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md deleted file mode 100644 index d583aae0e0b19..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) - -## OverlayFlyoutOpenOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md deleted file mode 100644 index 26f6db77cccea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [className](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) - -## OverlayFlyoutOpenOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md deleted file mode 100644 index 44014b7f0d816..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) - -## OverlayFlyoutOpenOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md deleted file mode 100644 index 149a53f35d34d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [hideCloseButton](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) - -## OverlayFlyoutOpenOptions.hideCloseButton property - -Signature: - -```typescript -hideCloseButton?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md deleted file mode 100644 index 3cb3e0b4902a9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [maskProps](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md) - -## OverlayFlyoutOpenOptions.maskProps property - -Signature: - -```typescript -maskProps?: EuiOverlayMaskProps; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md deleted file mode 100644 index 4f582e746191f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [maxWidth](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) - -## OverlayFlyoutOpenOptions.maxWidth property - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md deleted file mode 100644 index 86117422e5faf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - -## OverlayFlyoutOpenOptions interface - - -Signature: - -```typescript -export interface OverlayFlyoutOpenOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["aria-label"?](./kibana-plugin-core-public.overlayflyoutopenoptions._aria-label_.md) | string | (Optional) | -| ["data-test-subj"?](./kibana-plugin-core-public.overlayflyoutopenoptions._data-test-subj_.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) | string | (Optional) | -| [hideCloseButton?](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) | boolean | (Optional) | -| [maskProps?](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md) | EuiOverlayMaskProps | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) | -| [onClose?](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) | (flyout: OverlayRef) => void | (Optional) EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; | -| [outsideClickCloses?](./kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md) | boolean | (Optional) | -| [ownFocus?](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) | boolean | (Optional) | -| [size?](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) | EuiFlyoutSize | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md deleted file mode 100644 index 5cfbba4c84a36..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [onClose](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) - -## OverlayFlyoutOpenOptions.onClose property - -EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; - -Signature: - -```typescript -onClose?: (flyout: OverlayRef) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md deleted file mode 100644 index acb9bac6f55da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [outsideClickCloses](./kibana-plugin-core-public.overlayflyoutopenoptions.outsideclickcloses.md) - -## OverlayFlyoutOpenOptions.outsideClickCloses property - -Signature: - -```typescript -outsideClickCloses?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md deleted file mode 100644 index 337ce2c48e1d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [ownFocus](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) - -## OverlayFlyoutOpenOptions.ownFocus property - -Signature: - -```typescript -ownFocus?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md deleted file mode 100644 index 3754242dc7c26..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.size.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) > [size](./kibana-plugin-core-public.overlayflyoutopenoptions.size.md) - -## OverlayFlyoutOpenOptions.size property - -Signature: - -```typescript -size?: EuiFlyoutSize; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md deleted file mode 100644 index 790fd57320413..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) - -## OverlayFlyoutStart interface - -APIs to open and manage fly-out dialogs. - -Signature: - -```typescript -export interface OverlayFlyoutStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [open(mount, options)](./kibana-plugin-core-public.overlayflyoutstart.open.md) | Opens a flyout panel with the given mount point inside. You can use close() on the returned FlyoutRef to close the flyout. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md deleted file mode 100644 index 94290eb91f942..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayflyoutstart.open.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayFlyoutStart](./kibana-plugin-core-public.overlayflyoutstart.md) > [open](./kibana-plugin-core-public.overlayflyoutstart.open.md) - -## OverlayFlyoutStart.open() method - -Opens a flyout panel with the given mount point inside. You can use `close()` on the returned FlyoutRef to close the flyout. - -Signature: - -```typescript -open(mount: MountPoint, options?: OverlayFlyoutOpenOptions): OverlayRef; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside a flyout panel | -| options | OverlayFlyoutOpenOptions | [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) - options for the flyout [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened flyout panel. | - -Returns: - -OverlayRef - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md deleted file mode 100644 index 3569b2153c3da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) - -## OverlayModalConfirmOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md deleted file mode 100644 index 5c827e19e42e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [buttonColor](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) - -## OverlayModalConfirmOptions.buttonColor property - -Signature: - -```typescript -buttonColor?: EuiConfirmModalProps['buttonColor']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md deleted file mode 100644 index 0c0b9fd48dbd6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [cancelButtonText](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) - -## OverlayModalConfirmOptions.cancelButtonText property - -Signature: - -```typescript -cancelButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md deleted file mode 100644 index 0a622aeaac418..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [className](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) - -## OverlayModalConfirmOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md deleted file mode 100644 index 8a321a0b07b4c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) - -## OverlayModalConfirmOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md deleted file mode 100644 index f84d834369f5b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [confirmButtonText](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) - -## OverlayModalConfirmOptions.confirmButtonText property - -Signature: - -```typescript -confirmButtonText?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md deleted file mode 100644 index c5edf48b54ea8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [defaultFocusedButton](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) - -## OverlayModalConfirmOptions.defaultFocusedButton property - -Signature: - -```typescript -defaultFocusedButton?: EuiConfirmModalProps['defaultFocusedButton']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md deleted file mode 100644 index 488b4eb3794fb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [maxWidth](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) - -## OverlayModalConfirmOptions.maxWidth property - -Sets the max-width of the modal. Set to `true` to use the default (`euiBreakpoints 'm'`), set to `false` to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md deleted file mode 100644 index 2f672e551ba51..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) - -## OverlayModalConfirmOptions interface - - -Signature: - -```typescript -export interface OverlayModalConfirmOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalconfirmoptions._data-test-subj_.md) | string | (Optional) | -| [buttonColor?](./kibana-plugin-core-public.overlaymodalconfirmoptions.buttoncolor.md) | EuiConfirmModalProps\['buttonColor'\] | (Optional) | -| [cancelButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.cancelbuttontext.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlaymodalconfirmoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalconfirmoptions.closebuttonarialabel.md) | string | (Optional) | -| [confirmButtonText?](./kibana-plugin-core-public.overlaymodalconfirmoptions.confirmbuttontext.md) | string | (Optional) | -| [defaultFocusedButton?](./kibana-plugin-core-public.overlaymodalconfirmoptions.defaultfocusedbutton.md) | EuiConfirmModalProps\['defaultFocusedButton'\] | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlaymodalconfirmoptions.maxwidth.md) | boolean \| number \| string | (Optional) Sets the max-width of the modal. Set to true to use the default (euiBreakpoints 'm'), set to false to not restrict the width, set to a number for a custom width in px, set to a string for a custom width in custom measurement. | -| [title?](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md deleted file mode 100644 index cfbe41e0a7e9f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalconfirmoptions.title.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) > [title](./kibana-plugin-core-public.overlaymodalconfirmoptions.title.md) - -## OverlayModalConfirmOptions.title property - -Signature: - -```typescript -title?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md deleted file mode 100644 index f0eba659dc62b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > ["data-test-subj"](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) - -## OverlayModalOpenOptions."data-test-subj" property - -Signature: - -```typescript -'data-test-subj'?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md deleted file mode 100644 index 769387b8c35ff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.classname.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [className](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) - -## OverlayModalOpenOptions.className property - -Signature: - -```typescript -className?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md deleted file mode 100644 index 4e685055b9e17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [closeButtonAriaLabel](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) - -## OverlayModalOpenOptions.closeButtonAriaLabel property - -Signature: - -```typescript -closeButtonAriaLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md deleted file mode 100644 index 0ae888f9cb361..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) > [maxWidth](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) - -## OverlayModalOpenOptions.maxWidth property - -Signature: - -```typescript -maxWidth?: boolean | number | string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md deleted file mode 100644 index 5fc978ea26262..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalopenoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - -## OverlayModalOpenOptions interface - - -Signature: - -```typescript -export interface OverlayModalOpenOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["data-test-subj"?](./kibana-plugin-core-public.overlaymodalopenoptions._data-test-subj_.md) | string | (Optional) | -| [className?](./kibana-plugin-core-public.overlaymodalopenoptions.classname.md) | string | (Optional) | -| [closeButtonAriaLabel?](./kibana-plugin-core-public.overlaymodalopenoptions.closebuttonarialabel.md) | string | (Optional) | -| [maxWidth?](./kibana-plugin-core-public.overlaymodalopenoptions.maxwidth.md) | boolean \| number \| string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md deleted file mode 100644 index 1d8fe1a92dd90..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) - -## OverlayModalStart interface - -APIs to open and manage modal dialogs. - -Signature: - -```typescript -export interface OverlayModalStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [open(mount, options)](./kibana-plugin-core-public.overlaymodalstart.open.md) | Opens a modal panel with the given mount point inside. You can use close() on the returned OverlayRef to close the modal. | -| [openConfirm(message, options)](./kibana-plugin-core-public.overlaymodalstart.openconfirm.md) | Opens a confirmation modal with the given text or mountpoint as a message. Returns a Promise resolving to true if user confirmed or false otherwise. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md deleted file mode 100644 index 35bfa406b4d17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.open.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) > [open](./kibana-plugin-core-public.overlaymodalstart.open.md) - -## OverlayModalStart.open() method - -Opens a modal panel with the given mount point inside. You can use `close()` on the returned OverlayRef to close the modal. - -Signature: - -```typescript -open(mount: MountPoint, options?: OverlayModalOpenOptions): OverlayRef; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mount | MountPoint | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - Mounts the children inside the modal | -| options | OverlayModalOpenOptions | [OverlayModalOpenOptions](./kibana-plugin-core-public.overlaymodalopenoptions.md) - options for the modal [OverlayRef](./kibana-plugin-core-public.overlayref.md) A reference to the opened modal. | - -Returns: - -OverlayRef - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md b/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md deleted file mode 100644 index 056f512de87bf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaymodalstart.openconfirm.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayModalStart](./kibana-plugin-core-public.overlaymodalstart.md) > [openConfirm](./kibana-plugin-core-public.overlaymodalstart.openconfirm.md) - -## OverlayModalStart.openConfirm() method - -Opens a confirmation modal with the given text or mountpoint as a message. Returns a Promise resolving to `true` if user confirmed or `false` otherwise. - -Signature: - -```typescript -openConfirm(message: MountPoint | string, options?: OverlayModalConfirmOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | MountPoint \| string | [MountPoint](./kibana-plugin-core-public.mountpoint.md) - string or mountpoint to be used a the confirm message body | -| options | OverlayModalConfirmOptions | [OverlayModalConfirmOptions](./kibana-plugin-core-public.overlaymodalconfirmoptions.md) - options for the confirm modal | - -Returns: - -Promise<boolean> - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md deleted file mode 100644 index 454723f6ffd09..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.close.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) > [close](./kibana-plugin-core-public.overlayref.close.md) - -## OverlayRef.close() method - -Closes the referenced overlay if it's still open which in turn will resolve the `onClose` Promise. If the overlay had already been closed this method does nothing. - -Signature: - -```typescript -close(): Promise; -``` -Returns: - -Promise<void> - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.md deleted file mode 100644 index da11e284f285d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) - -## OverlayRef interface - -Returned by [OverlayStart](./kibana-plugin-core-public.overlaystart.md) methods for closing a mounted overlay. - -Signature: - -```typescript -export interface OverlayRef -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [onClose](./kibana-plugin-core-public.overlayref.onclose.md) | Promise<void> | A Promise that will resolve once this overlay is closed.Overlays can close from user interaction, calling close() on the overlay reference or another overlay replacing yours via openModal or openFlyout. | - -## Methods - -| Method | Description | -| --- | --- | -| [close()](./kibana-plugin-core-public.overlayref.close.md) | Closes the referenced overlay if it's still open which in turn will resolve the onClose Promise. If the overlay had already been closed this method does nothing. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md b/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md deleted file mode 100644 index 3752c6ecf7de0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlayref.onclose.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayRef](./kibana-plugin-core-public.overlayref.md) > [onClose](./kibana-plugin-core-public.overlayref.onclose.md) - -## OverlayRef.onClose property - -A Promise that will resolve once this overlay is closed. - -Overlays can close from user interaction, calling `close()` on the overlay reference or another overlay replacing yours via `openModal` or `openFlyout`. - -Signature: - -```typescript -onClose: Promise; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md deleted file mode 100644 index 2cb1565a4cfc4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.banners.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [banners](./kibana-plugin-core-public.overlaystart.banners.md) - -## OverlayStart.banners property - -[OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) - -Signature: - -```typescript -banners: OverlayBannersStart; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.md deleted file mode 100644 index 3bbdd4ab9b918..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) - -## OverlayStart interface - - -Signature: - -```typescript -export interface OverlayStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [banners](./kibana-plugin-core-public.overlaystart.banners.md) | OverlayBannersStart | [OverlayBannersStart](./kibana-plugin-core-public.overlaybannersstart.md) | -| [openConfirm](./kibana-plugin-core-public.overlaystart.openconfirm.md) | OverlayModalStart\['openConfirm'\] | | -| [openFlyout](./kibana-plugin-core-public.overlaystart.openflyout.md) | OverlayFlyoutStart\['open'\] | | -| [openModal](./kibana-plugin-core-public.overlaystart.openmodal.md) | OverlayModalStart\['open'\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md deleted file mode 100644 index cfa27f4ea6f60..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openconfirm.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openConfirm](./kibana-plugin-core-public.overlaystart.openconfirm.md) - -## OverlayStart.openConfirm property - - -Signature: - -```typescript -openConfirm: OverlayModalStart['openConfirm']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md deleted file mode 100644 index 8059918b0ec10..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openflyout.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openFlyout](./kibana-plugin-core-public.overlaystart.openflyout.md) - -## OverlayStart.openFlyout property - - -Signature: - -```typescript -openFlyout: OverlayFlyoutStart['open']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md b/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md deleted file mode 100644 index 5b55084c78727..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.overlaystart.openmodal.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [OverlayStart](./kibana-plugin-core-public.overlaystart.md) > [openModal](./kibana-plugin-core-public.overlaystart.openmodal.md) - -## OverlayStart.openModal property - - -Signature: - -```typescript -openModal: OverlayModalStart['open']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.md deleted file mode 100644 index da8cef9b83cc7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) - -## Plugin\_2 interface - -The interface that should be returned by a `PluginInitializer`. - -Signature: - -```typescript -export interface Plugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-public.plugin_2.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-public.plugin_2.start.md) | | -| [stop()?](./kibana-plugin-core-public.plugin_2.stop.md) | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md deleted file mode 100644 index 5ebb5a1a74811..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [setup](./kibana-plugin-core-public.plugin_2.setup.md) - -## Plugin\_2.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup<TPluginsStart, TStart> | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md deleted file mode 100644 index f4979ee033aac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [start](./kibana-plugin-core-public.plugin_2.start.md) - -## Plugin\_2.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md b/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md deleted file mode 100644 index 69532f2d0e09d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugin_2.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Plugin\_2](./kibana-plugin-core-public.plugin_2.md) > [stop](./kibana-plugin-core-public.plugin_2.stop.md) - -## Plugin\_2.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md deleted file mode 100644 index 1fcc2999dfd2e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializer](./kibana-plugin-core-public.plugininitializer.md) - -## PluginInitializer type - -The `plugin` export at the root of a plugin's `public` directory should conform to this interface. - -Signature: - -```typescript -export declare type PluginInitializer = (core: PluginInitializerContext) => Plugin; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md deleted file mode 100644 index 0f4d7df94a30e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.config.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [config](./kibana-plugin-core-public.plugininitializercontext.config.md) - -## PluginInitializerContext.config property - -Signature: - -```typescript -readonly config: { - get: () => T; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md deleted file mode 100644 index 532561eafc4d7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.env.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [env](./kibana-plugin-core-public.plugininitializercontext.env.md) - -## PluginInitializerContext.env property - -Signature: - -```typescript -readonly env: { - mode: Readonly; - packageInfo: Readonly; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md deleted file mode 100644 index 3304b4bf3def4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) - -## PluginInitializerContext interface - -The available core services passed to a `PluginInitializer` - -Signature: - -```typescript -export interface PluginInitializerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-public.plugininitializercontext.config.md) | { get: <T extends object = ConfigSchema>() => T; } | | -| [env](./kibana-plugin-core-public.plugininitializercontext.env.md) | { mode: Readonly<EnvironmentMode>; packageInfo: Readonly<PackageInfo>; } | | -| [opaqueId](./kibana-plugin-core-public.plugininitializercontext.opaqueid.md) | PluginOpaqueId | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md b/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md deleted file mode 100644 index 8ee0c3a415ee3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.plugininitializercontext.opaqueid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PluginInitializerContext](./kibana-plugin-core-public.plugininitializercontext.md) > [opaqueId](./kibana-plugin-core-public.plugininitializercontext.opaqueid.md) - -## PluginInitializerContext.opaqueId property - -A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. - -Signature: - -```typescript -readonly opaqueId: PluginOpaqueId; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md b/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md deleted file mode 100644 index 40fd98687c619..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicappdeeplinkinfo.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicAppDeepLinkInfo](./kibana-plugin-core-public.publicappdeeplinkinfo.md) - -## PublicAppDeepLinkInfo type - -Public information about a registered app's [deepLinks](./kibana-plugin-core-public.appdeeplink.md) - -Signature: - -```typescript -export declare type PublicAppDeepLinkInfo = Omit & { - deepLinks: PublicAppDeepLinkInfo[]; - keywords: string[]; - navLinkStatus: AppNavLinkStatus; - searchable: boolean; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md b/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md deleted file mode 100644 index 01d23ae47a0d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicappinfo.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicAppInfo](./kibana-plugin-core-public.publicappinfo.md) - -## PublicAppInfo type - -Public information about a registered [application](./kibana-plugin-core-public.app.md) - -Signature: - -```typescript -export declare type PublicAppInfo = Omit & { - status: AppStatus; - navLinkStatus: AppNavLinkStatus; - appRoute: string; - keywords: string[]; - deepLinks: PublicAppDeepLinkInfo[]; - searchable: boolean; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md deleted file mode 100644 index 678a69289ff23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.publicuisettingsparams.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [PublicUiSettingsParams](./kibana-plugin-core-public.publicuisettingsparams.md) - -## PublicUiSettingsParams type - -A sub-set of [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) exposed to the client-side. - -Signature: - -```typescript -export declare type PublicUiSettingsParams = Omit; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md b/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md deleted file mode 100644 index 928bf8c07004e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedeprecationresponse.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolveDeprecationResponse](./kibana-plugin-core-public.resolvedeprecationresponse.md) - -## ResolveDeprecationResponse type - -Signature: - -```typescript -export declare type ResolveDeprecationResponse = { - status: 'ok'; -} | { - status: 'fail'; - reason: string; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md deleted file mode 100644 index fb6f98eda62d1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [alias\_purpose](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md) - -## ResolvedSimpleSavedObject.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: SavedObjectsResolveResponse['alias_purpose']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md deleted file mode 100644 index 0e82842ef749d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [alias\_target\_id](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md) - -## ResolvedSimpleSavedObject.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: SavedObjectsResolveResponse['alias_target_id']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md deleted file mode 100644 index 92ae014380f14..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) - -## ResolvedSimpleSavedObject interface - -This interface is a very simple wrapper for SavedObjects resolved from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). - -Signature: - -```typescript -export interface ResolvedSimpleSavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_purpose.md) | SavedObjectsResolveResponse\['alias\_purpose'\] | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-public.resolvedsimplesavedobject.alias_target_id.md) | SavedObjectsResolveResponse\['alias\_target\_id'\] | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) | SavedObjectsResolveResponse\['outcome'\] | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md) | SimpleSavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md deleted file mode 100644 index ceeef7706cc0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) - -## ResolvedSimpleSavedObject.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: SavedObjectsResolveResponse['outcome']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md b/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md deleted file mode 100644 index 7d90791a26fd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) > [saved\_object](./kibana-plugin-core-public.resolvedsimplesavedobject.saved_object.md) - -## ResolvedSimpleSavedObject.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SimpleSavedObject; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md deleted file mode 100644 index bf64b25c04f92..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [attributes](./kibana-plugin-core-public.responseerrorbody.attributes.md) - -## ResponseErrorBody.attributes property - -Signature: - -```typescript -attributes?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md deleted file mode 100644 index 5bc9103691014..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) - -## ResponseErrorBody interface - - -Signature: - -```typescript -export interface ResponseErrorBody -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes?](./kibana-plugin-core-public.responseerrorbody.attributes.md) | Record<string, unknown> | (Optional) | -| [message](./kibana-plugin-core-public.responseerrorbody.message.md) | string | | -| [statusCode](./kibana-plugin-core-public.responseerrorbody.statuscode.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md deleted file mode 100644 index a3355ddafde1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [message](./kibana-plugin-core-public.responseerrorbody.message.md) - -## ResponseErrorBody.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md deleted file mode 100644 index a342bb0187d72..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.responseerrorbody.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ResponseErrorBody](./kibana-plugin-core-public.responseerrorbody.md) > [statusCode](./kibana-plugin-core-public.responseerrorbody.statuscode.md) - -## ResponseErrorBody.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md deleted file mode 100644 index e8b1e0927baff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [attributes](./kibana-plugin-core-public.savedobject.attributes.md) - -## SavedObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md deleted file mode 100644 index 9060a5d6777fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobject.coremigrationversion.md) - -## SavedObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md deleted file mode 100644 index ab9a611fc3a5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [error](./kibana-plugin-core-public.savedobject.error.md) - -## SavedObject.error property - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md deleted file mode 100644 index 34387f24bfcef..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [id](./kibana-plugin-core-public.savedobject.id.md) - -## SavedObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.md deleted file mode 100644 index 283a960013305..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) - -## SavedObject interface - -Signature: - -```typescript -export interface SavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobject.attributes.md) | T | The data for a Saved Object is stored as an object in the attributes property. | -| [coreMigrationVersion?](./kibana-plugin-core-public.savedobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [error?](./kibana-plugin-core-public.savedobject.error.md) | SavedObjectError | (Optional) | -| [id](./kibana-plugin-core-public.savedobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [migrationVersion?](./kibana-plugin-core-public.savedobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [namespaces?](./kibana-plugin-core-public.savedobject.namespaces.md) | string\[\] | (Optional) Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [originId?](./kibana-plugin-core-public.savedobject.originid.md) | string | (Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. | -| [references](./kibana-plugin-core-public.savedobject.references.md) | SavedObjectReference\[\] | A reference to another saved object. | -| [type](./kibana-plugin-core-public.savedobject.type.md) | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. | -| [updated\_at?](./kibana-plugin-core-public.savedobject.updated_at.md) | string | (Optional) Timestamp of the last time this document had been updated. | -| [version?](./kibana-plugin-core-public.savedobject.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md deleted file mode 100644 index c13b6dc429208..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [migrationVersion](./kibana-plugin-core-public.savedobject.migrationversion.md) - -## SavedObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md deleted file mode 100644 index 3418b964ab2d7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [namespaces](./kibana-plugin-core-public.savedobject.namespaces.md) - -## SavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md deleted file mode 100644 index f5bab09b9bcc0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [originId](./kibana-plugin-core-public.savedobject.originid.md) - -## SavedObject.originId property - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md deleted file mode 100644 index 09f6b8fb12b42..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [references](./kibana-plugin-core-public.savedobject.references.md) - -## SavedObject.references property - -A reference to another saved object. - -Signature: - -```typescript -references: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md deleted file mode 100644 index ccaa1f1d5231c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [type](./kibana-plugin-core-public.savedobject.type.md) - -## SavedObject.type property - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md deleted file mode 100644 index 111d4b676f00a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.updated_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [updated\_at](./kibana-plugin-core-public.savedobject.updated_at.md) - -## SavedObject.updated\_at property - -Timestamp of the last time this document had been updated. - -Signature: - -```typescript -updated_at?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md deleted file mode 100644 index 23b8b3f40da2a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobject.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObject](./kibana-plugin-core-public.savedobject.md) > [version](./kibana-plugin-core-public.savedobject.version.md) - -## SavedObject.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md deleted file mode 100644 index 2d7be060e28fe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattribute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) - -## SavedObjectAttribute type - -Type definition for a Saved Object attribute value - -Signature: - -```typescript -export declare type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md deleted file mode 100644 index 0493f52b11425..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttributes](./kibana-plugin-core-public.savedobjectattributes.md) - -## SavedObjectAttributes interface - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -export interface SavedObjectAttributes -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md deleted file mode 100644 index 388cfac2d9c33..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectattributesingle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectAttributeSingle](./kibana-plugin-core-public.savedobjectattributesingle.md) - -## SavedObjectAttributeSingle type - -Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-public.savedobjectattribute.md) - -Signature: - -```typescript -export declare type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md deleted file mode 100644 index 87180a520090f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [error](./kibana-plugin-core-public.savedobjecterror.error.md) - -## SavedObjectError.error property - -Signature: - -```typescript -error: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md deleted file mode 100644 index f6e8874b212b0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) - -## SavedObjectError interface - -Signature: - -```typescript -export interface SavedObjectError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.savedobjecterror.error.md) | string | | -| [message](./kibana-plugin-core-public.savedobjecterror.message.md) | string | | -| [metadata?](./kibana-plugin-core-public.savedobjecterror.metadata.md) | Record<string, unknown> | (Optional) | -| [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md deleted file mode 100644 index 2a51d4d1a514d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [message](./kibana-plugin-core-public.savedobjecterror.message.md) - -## SavedObjectError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md deleted file mode 100644 index a2725f0206655..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.metadata.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [metadata](./kibana-plugin-core-public.savedobjecterror.metadata.md) - -## SavedObjectError.metadata property - -Signature: - -```typescript -metadata?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md deleted file mode 100644 index 75a57e98fece2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjecterror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectError](./kibana-plugin-core-public.savedobjecterror.md) > [statusCode](./kibana-plugin-core-public.savedobjecterror.statuscode.md) - -## SavedObjectError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md deleted file mode 100644 index 91f0213f7e3f0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [id](./kibana-plugin-core-public.savedobjectreference.id.md) - -## SavedObjectReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md deleted file mode 100644 index e63ba254602db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) - -## SavedObjectReference interface - -A reference to another saved object. - -Signature: - -```typescript -export interface SavedObjectReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectreference.id.md) | string | | -| [name](./kibana-plugin-core-public.savedobjectreference.name.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectreference.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md deleted file mode 100644 index a5389047b5a4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [name](./kibana-plugin-core-public.savedobjectreference.name.md) - -## SavedObjectReference.name property - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md deleted file mode 100644 index 9547d52c404b2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReference](./kibana-plugin-core-public.savedobjectreference.md) > [type](./kibana-plugin-core-public.savedobjectreference.type.md) - -## SavedObjectReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md deleted file mode 100644 index 10e01d7e7a931..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [id](./kibana-plugin-core-public.savedobjectreferencewithcontext.id.md) - -## SavedObjectReferenceWithContext.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md deleted file mode 100644 index 722b11f0c7ba9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [inboundReferences](./kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md) - -## SavedObjectReferenceWithContext.inboundReferences property - -References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation - -Signature: - -```typescript -inboundReferences: Array<{ - type: string; - id: string; - name: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md deleted file mode 100644 index 8a4b378850764..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [isMissing](./kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md) - -## SavedObjectReferenceWithContext.isMissing property - -Whether or not this object or reference is missing - -Signature: - -```typescript -isMissing?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md deleted file mode 100644 index 2b43bafbede5c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) - -## SavedObjectReferenceWithContext interface - -A returned input object or one of its references, with additional context. - -Signature: - -```typescript -export interface SavedObjectReferenceWithContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectreferencewithcontext.id.md) | string | The ID of the referenced object | -| [inboundReferences](./kibana-plugin-core-public.savedobjectreferencewithcontext.inboundreferences.md) | Array<{ type: string; id: string; name: string; }> | References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation | -| [isMissing?](./kibana-plugin-core-public.savedobjectreferencewithcontext.ismissing.md) | boolean | (Optional) Whether or not this object or reference is missing | -| [originId?](./kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md) | string | (Optional) The origin ID of the referenced object (if it has one) | -| [spaces](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [spacesWithMatchingAliases?](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) | string\[\] | (Optional) The space(s) that legacy URL aliases matching this type/id exist in | -| [spacesWithMatchingOrigins?](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) | string\[\] | (Optional) The space(s) that objects matching this origin exist in (including this one) | -| [type](./kibana-plugin-core-public.savedobjectreferencewithcontext.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md deleted file mode 100644 index 418041ea5df60..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [originId](./kibana-plugin-core-public.savedobjectreferencewithcontext.originid.md) - -## SavedObjectReferenceWithContext.originId property - -The origin ID of the referenced object (if it has one) - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md deleted file mode 100644 index 9140e94721f1e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spaces](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaces.md) - -## SavedObjectReferenceWithContext.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md deleted file mode 100644 index 02b0c9c0949df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spacesWithMatchingAliases](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingAliases property - -The space(s) that legacy URL aliases matching this type/id exist in - -Signature: - -```typescript -spacesWithMatchingAliases?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md deleted file mode 100644 index 88a7ebb5f2234..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [spacesWithMatchingOrigins](./kibana-plugin-core-public.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingOrigins property - -The space(s) that objects matching this origin exist in (including this one) - -Signature: - -```typescript -spacesWithMatchingOrigins?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md deleted file mode 100644 index d2e341627153c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectreferencewithcontext.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-public.savedobjectreferencewithcontext.md) > [type](./kibana-plugin-core-public.savedobjectreferencewithcontext.type.md) - -## SavedObjectReferenceWithContext.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md deleted file mode 100644 index f86d3b5afc04e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) - -## SavedObjectsBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md) | string | (Optional) Specify the namespace for this operation | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md deleted file mode 100644 index 5b394750d618c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-public.savedobjectsbaseoptions.md) > [namespace](./kibana-plugin-core-public.savedobjectsbaseoptions.namespace.md) - -## SavedObjectsBaseOptions.namespace property - -Specify the namespace for this operation - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md deleted file mode 100644 index 3926231db17b5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) - -## SavedObjectsBatchResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBatchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [savedObjects](./kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md) | Array<SimpleSavedObject<T>> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md deleted file mode 100644 index 53db81aaad89a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-core-public.savedobjectsbatchresponse.md) > [savedObjects](./kibana-plugin-core-public.savedobjectsbatchresponse.savedobjects.md) - -## SavedObjectsBatchResponse.savedObjects property - -Signature: - -```typescript -savedObjects: Array>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md deleted file mode 100644 index fea1505c9b6f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) > [attributes](./kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md) - -## SavedObjectsBulkCreateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md deleted file mode 100644 index f9ff61859b1a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) - -## SavedObjectsBulkCreateObject interface - -Signature: - -```typescript -export interface SavedObjectsBulkCreateObject extends SavedObjectsCreateOptions -``` -Extends: SavedObjectsCreateOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobjectsbulkcreateobject.attributes.md) | T | | -| [type](./kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md deleted file mode 100644 index afadde06db494..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-public.savedobjectsbulkcreateobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkcreateobject.type.md) - -## SavedObjectsBulkCreateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md deleted file mode 100644 index ada12c064e0a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) - -## SavedObjectsBulkCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkCreateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [overwrite?](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md) | boolean | (Optional) If a document with the given id already exists, overwrite it's contents (default=false). | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md deleted file mode 100644 index 20d5f84b1cf33..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.md) > [overwrite](./kibana-plugin-core-public.savedobjectsbulkcreateoptions.overwrite.md) - -## SavedObjectsBulkCreateOptions.overwrite property - -If a document with the given `id` already exists, overwrite it's contents (default=false). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md deleted file mode 100644 index 6a8fd52a4dc49..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) > [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) - -## SavedObjectsBulkResolveObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md deleted file mode 100644 index fbff3d3bd8f25..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) - -## SavedObjectsBulkResolveObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectsbulkresolveobject.id.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md deleted file mode 100644 index 09c7991012da8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) - -## SavedObjectsBulkResolveObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md deleted file mode 100644 index 311b1bf262875..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) - -## SavedObjectsBulkResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolved\_objects](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md) | Array<ResolvedSimpleSavedObject<T>> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md deleted file mode 100644 index e2bf3828841de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md) - -## SavedObjectsBulkResolveResponse.resolved\_objects property - -Signature: - -```typescript -resolved_objects: Array>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md deleted file mode 100644 index 1c124970287e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [attributes](./kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md) - -## SavedObjectsBulkUpdateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md deleted file mode 100644 index 4fad01d2f2641..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [id](./kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md) - -## SavedObjectsBulkUpdateObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md deleted file mode 100644 index f28d99cb110c6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) - -## SavedObjectsBulkUpdateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-public.savedobjectsbulkupdateobject.attributes.md) | T | | -| [id](./kibana-plugin-core-public.savedobjectsbulkupdateobject.id.md) | string | | -| [references?](./kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md) | SavedObjectReference\[\] | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md) | string | | -| [version?](./kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md deleted file mode 100644 index 64b9b56a5c0d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [references](./kibana-plugin-core-public.savedobjectsbulkupdateobject.references.md) - -## SavedObjectsBulkUpdateObject.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md deleted file mode 100644 index 2dd5a879491a8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkupdateobject.type.md) - -## SavedObjectsBulkUpdateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md deleted file mode 100644 index 18e4259e89b35..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-public.savedobjectsbulkupdateobject.md) > [version](./kibana-plugin-core-public.savedobjectsbulkupdateobject.version.md) - -## SavedObjectsBulkUpdateObject.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md deleted file mode 100644 index a2cdd3eb801e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) - -## SavedObjectsBulkUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md deleted file mode 100644 index a6c0e92098bdc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.md) > [namespace](./kibana-plugin-core-public.savedobjectsbulkupdateoptions.namespace.md) - -## SavedObjectsBulkUpdateOptions.namespace property - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md deleted file mode 100644 index 98c5e250644ff..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkCreate](./kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md) - -## SavedObjectsClientContract.bulkCreate() method - -Creates multiple documents at once - -Signature: - -```typescript -bulkCreate(objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkCreateObject\[\] | | -| options | SavedObjectsBulkCreateOptions | | - -Returns: - -Promise<SavedObjectsBatchResponse<unknown>> - -The result of the create operation containing created saved objects. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md deleted file mode 100644 index b091f14308177..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkGet](./kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md) - -## SavedObjectsClientContract.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects: Array<{ - id: string; - type: string; - }>): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<{ id: string; type: string; }> | an array ids, or an array of objects containing id and optionally type | - -Returns: - -Promise<SavedObjectsBatchResponse<unknown>> - -The saved objects with the given type and ids requested - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md deleted file mode 100644 index cb67bdc19d23c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkResolve](./kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md) - -## SavedObjectsClientContract.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: Array<{ - id: string; - type: string; - }>): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<{ id: string; type: string; }> | an array of objects containing id, type | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -The bulk resolve result for the saved objects for the given types and ids. - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. The `resolve` method in the public client uses `bulkResolve` under the hood, so it behaves the same way. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md deleted file mode 100644 index 84c461708218c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [bulkUpdate](./kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md) - -## SavedObjectsClientContract.bulkUpdate() method - -Update multiple documents at once - -Signature: - -```typescript -bulkUpdate(objects: SavedObjectsBulkUpdateObject[]): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkUpdateObject\[\] | \[{ type, id, attributes, options: { version, references } }\] | - -Returns: - -Promise<SavedObjectsBatchResponse<T>> - -The result of the update operation containing both failed and updated saved objects. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md deleted file mode 100644 index 76906c0dba8d5..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.create.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [create](./kibana-plugin-core-public.savedobjectsclientcontract.create.md) - -## SavedObjectsClientContract.create() method - -Persists an object - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SimpleSavedObject<T>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md deleted file mode 100644 index 39aee28ee7e01..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.delete.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [delete](./kibana-plugin-core-public.savedobjectsclientcontract.delete.md) - -## SavedObjectsClientContract.delete() method - -Deletes an object - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | | - -Returns: - -Promise<{}> - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md deleted file mode 100644 index 8173773e461f3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.find.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [find](./kibana-plugin-core-public.savedobjectsclientcontract.find.md) - -## SavedObjectsClientContract.find() method - -Search for objects - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | {string} options.type {string} options.search {string} options.searchFields - see Elasticsearch Simple Query String Query field argument for more information {integer} \[options.page=1\] {integer} \[options.perPage=20\] {array} options.fields {object} \[options.hasReference\] - { type, id } | - -Returns: - -Promise<SavedObjectsFindResponsePublic<T>> - -A find result with objects matching the specified search. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md deleted file mode 100644 index 4184e0a16ab5e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.get.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [get](./kibana-plugin-core-public.savedobjectsclientcontract.get.md) - -## SavedObjectsClientContract.get() method - -Fetches a single object - -Signature: - -```typescript -get(type: string, id: string): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -Promise<SimpleSavedObject<T>> - -The saved object for the given type and id. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md deleted file mode 100644 index bdc76b58f8dc2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) - -## SavedObjectsClientContract interface - -The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. - -Signature: - -```typescript -export interface SavedObjectsClientContract -``` - -## Methods - -| Method | Description | -| --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkcreate.md) | Creates multiple documents at once | -| [bulkGet(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkget.md) | Returns an array of objects by id | -| [bulkResolve(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkresolve.md) | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects)](./kibana-plugin-core-public.savedobjectsclientcontract.bulkupdate.md) | Update multiple documents at once | -| [create(type, attributes, options)](./kibana-plugin-core-public.savedobjectsclientcontract.create.md) | Persists an object | -| [delete(type, id, options)](./kibana-plugin-core-public.savedobjectsclientcontract.delete.md) | Deletes an object | -| [find(options)](./kibana-plugin-core-public.savedobjectsclientcontract.find.md) | Search for objects | -| [get(type, id)](./kibana-plugin-core-public.savedobjectsclientcontract.get.md) | Fetches a single object | -| [resolve(type, id)](./kibana-plugin-core-public.savedobjectsclientcontract.resolve.md) | Resolves a single object | -| [update(type, id, attributes, options)](./kibana-plugin-core-public.savedobjectsclientcontract.update.md) | Updates an object | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md deleted file mode 100644 index 6e9c9a1c9c945..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.resolve.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [resolve](./kibana-plugin-core-public.savedobjectsclientcontract.resolve.md) - -## SavedObjectsClientContract.resolve() method - -Resolves a single object - -Signature: - -```typescript -resolve(type: string, id: string): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -Promise<ResolvedSimpleSavedObject<T>> - -The resolve result for the saved object for the given type and id. - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior for the `resolve` API is unique to the public client, which batches individual calls with `bulkResolve` under the hood. We don't throw an error in that case for legacy compatibility reasons. - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md deleted file mode 100644 index 0652404b91ad4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsclientcontract.update.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) > [update](./kibana-plugin-core-public.savedobjectsclientcontract.update.md) - -## SavedObjectsClientContract.update() method - -Updates an object - -Signature: - -```typescript -update(type: string, id: string, attributes: T, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | T | | -| options | SavedObjectsUpdateOptions | {integer} options.version - ensures version matches that of persisted object {object} options.migrationVersion - The optional migrationVersion of this document | - -Returns: - -Promise<SimpleSavedObject<T>> - - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md deleted file mode 100644 index a356850fa1ad4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse interface - -The response when object references are collected. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md) | SavedObjectReferenceWithContext\[\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md deleted file mode 100644 index 66a7a19d18288..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.md) > [objects](./kibana-plugin-core-public.savedobjectscollectmultinamespacereferencesresponse.objects.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectReferenceWithContext[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md deleted file mode 100644 index 3c1d068f458bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) - -## SavedObjectsCreateOptions.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md deleted file mode 100644 index 14e64cc9b7b34..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [id](./kibana-plugin-core-public.savedobjectscreateoptions.id.md) - -## SavedObjectsCreateOptions.id property - -(Not recommended) Specify an id instead of having the saved objects service generate one for you. - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md deleted file mode 100644 index 835a9e87a1dba..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) - -## SavedObjectsCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsCreateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [coreMigrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [id?](./kibana-plugin-core-public.savedobjectscreateoptions.id.md) | string | (Optional) (Not recommended) Specify an id instead of having the saved objects service generate one for you. | -| [migrationVersion?](./kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [overwrite?](./kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md) | boolean | (Optional) If a document with the given id already exists, overwrite it's contents (default=false). | -| [references?](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) | SavedObjectReference\[\] | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md deleted file mode 100644 index 4ea4386303a58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [migrationVersion](./kibana-plugin-core-public.savedobjectscreateoptions.migrationversion.md) - -## SavedObjectsCreateOptions.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md deleted file mode 100644 index aa3e102e6c042..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [overwrite](./kibana-plugin-core-public.savedobjectscreateoptions.overwrite.md) - -## SavedObjectsCreateOptions.overwrite property - -If a document with the given `id` already exists, overwrite it's contents (default=false). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md deleted file mode 100644 index ef67cdb771630..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectscreateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) > [references](./kibana-plugin-core-public.savedobjectscreateoptions.references.md) - -## SavedObjectsCreateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md deleted file mode 100644 index f1c2fd08a21f1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [defaultSearchOperator](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) - -## SavedObjectsFindOptions.defaultSearchOperator property - -The search operator to use with the provided filter. Defaults to `OR` - -Signature: - -```typescript -defaultSearchOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md deleted file mode 100644 index 39bc1d3161bd4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.fields.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [fields](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) - -## SavedObjectsFindOptions.fields property - -An array of fields to include in the results - -Signature: - -```typescript -fields?: string[]; -``` - -## Example - -SavedObjects.find({type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]}) - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md deleted file mode 100644 index 2c20fe2dab00f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.filter.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [filter](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) - -## SavedObjectsFindOptions.filter property - -Signature: - -```typescript -filter?: string | KueryNode; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md deleted file mode 100644 index 25ce8fa7b6018..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [hasReference](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) - -## SavedObjectsFindOptions.hasReference property - -Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md deleted file mode 100644 index 3681d1c9d34d9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [hasReferenceOperator](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) - -## SavedObjectsFindOptions.hasReferenceOperator property - -The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - -Signature: - -```typescript -hasReferenceOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md deleted file mode 100644 index 98ac48f6cdbd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) - -## SavedObjectsFindOptions interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.defaultsearchoperator.md) | 'AND' \| 'OR' | (Optional) The search operator to use with the provided filter. Defaults to OR | -| [fields?](./kibana-plugin-core-public.savedobjectsfindoptions.fields.md) | string\[\] | (Optional) An array of fields to include in the results | -| [filter?](./kibana-plugin-core-public.savedobjectsfindoptions.filter.md) | string \| KueryNode | (Optional) | -| [hasReference?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | (Optional) Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. | -| [hasReferenceOperator?](./kibana-plugin-core-public.savedobjectsfindoptions.hasreferenceoperator.md) | 'AND' \| 'OR' | (Optional) The operator to use when searching by multiple references using the hasReference option. Defaults to OR | -| [namespaces?](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) | string\[\] | (Optional) | -| [page?](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | number | (Optional) | -| [perPage?](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | number | (Optional) | -| [pit?](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) | SavedObjectsPitParams | (Optional) Search against a specific Point In Time (PIT) that you've opened with . | -| [preference?](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query \* | -| [rootSearchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. | -| [search?](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) | string | (Optional) Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information | -| [searchAfter?](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) | estypes.Id\[\] | (Optional) Use the sort values from the previous page to retrieve the next page of results. | -| [searchFields?](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information | -| [sortField?](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) | string | (Optional) | -| [sortOrder?](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) | estypes.SortOrder | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) | string \| string\[\] | | -| [typeToNamespacesMap?](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) | Map<string, string\[\] \| undefined> | (Optional) This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md deleted file mode 100644 index 9cc9d64db1f65..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [namespaces](./kibana-plugin-core-public.savedobjectsfindoptions.namespaces.md) - -## SavedObjectsFindOptions.namespaces property - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md deleted file mode 100644 index e009a4ac8e393..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [page](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) - -## SavedObjectsFindOptions.page property - -Signature: - -```typescript -page?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md deleted file mode 100644 index 0c6f3464d194c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [perPage](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) - -## SavedObjectsFindOptions.perPage property - -Signature: - -```typescript -perPage?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md deleted file mode 100644 index 2284a4d8d210d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.pit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [pit](./kibana-plugin-core-public.savedobjectsfindoptions.pit.md) - -## SavedObjectsFindOptions.pit property - -Search against a specific Point In Time (PIT) that you've opened with . - -Signature: - -```typescript -pit?: SavedObjectsPitParams; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md deleted file mode 100644 index 8a30cb99c57bc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [preference](./kibana-plugin-core-public.savedobjectsfindoptions.preference.md) - -## SavedObjectsFindOptions.preference property - -An optional ES preference value to be used for the query \* - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md deleted file mode 100644 index faa971509eca2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [rootSearchFields](./kibana-plugin-core-public.savedobjectsfindoptions.rootsearchfields.md) - -## SavedObjectsFindOptions.rootSearchFields property - -The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not be modified. If used in conjunction with `searchFields`, both are concatenated together. - -Signature: - -```typescript -rootSearchFields?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md deleted file mode 100644 index a7d149b58be02..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [search](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) - -## SavedObjectsFindOptions.search property - -Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md deleted file mode 100644 index 7016e1f1b72de..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [searchAfter](./kibana-plugin-core-public.savedobjectsfindoptions.searchafter.md) - -## SavedObjectsFindOptions.searchAfter property - -Use the sort values from the previous page to retrieve the next page of results. - -Signature: - -```typescript -searchAfter?: estypes.Id[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md deleted file mode 100644 index c99864ac8c046..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [searchFields](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) - -## SavedObjectsFindOptions.searchFields property - -The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information - -Signature: - -```typescript -searchFields?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md deleted file mode 100644 index 7b5072c0e19df..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [sortField](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) - -## SavedObjectsFindOptions.sortField property - -Signature: - -```typescript -sortField?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md deleted file mode 100644 index 36f99e51ea8c6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [sortOrder](./kibana-plugin-core-public.savedobjectsfindoptions.sortorder.md) - -## SavedObjectsFindOptions.sortOrder property - -Signature: - -```typescript -sortOrder?: estypes.SortOrder; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md deleted file mode 100644 index b4ce216fab1ad..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [type](./kibana-plugin-core-public.savedobjectsfindoptions.type.md) - -## SavedObjectsFindOptions.type property - -Signature: - -```typescript -type: string | string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md deleted file mode 100644 index 4af8c9ddeaff4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) > [typeToNamespacesMap](./kibana-plugin-core-public.savedobjectsfindoptions.typetonamespacesmap.md) - -## SavedObjectsFindOptions.typeToNamespacesMap property - -This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. - -Signature: - -```typescript -typeToNamespacesMap?: Map; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md deleted file mode 100644 index 5e4c8dd982a0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) > [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md) - -## SavedObjectsFindOptionsReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md deleted file mode 100644 index cab03bf71393c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) - -## SavedObjectsFindOptionsReference interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptionsReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-public.savedobjectsfindoptionsreference.id.md) | string | | -| [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md deleted file mode 100644 index 3779bfd204a4b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-public.savedobjectsfindoptionsreference.md) > [type](./kibana-plugin-core-public.savedobjectsfindoptionsreference.type.md) - -## SavedObjectsFindOptionsReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md deleted file mode 100644 index 14401b02f25c7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [aggregations](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md) - -## SavedObjectsFindResponsePublic.aggregations property - -Signature: - -```typescript -aggregations?: A; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md deleted file mode 100644 index dd26960a95766..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) - -## SavedObjectsFindResponsePublic interface - -Return type of the Saved Objects `find()` method. - -\*Note\*: this type is different between the Public and Server Saved Objects clients. - -Signature: - -```typescript -export interface SavedObjectsFindResponsePublic extends SavedObjectsBatchResponse -``` -Extends: SavedObjectsBatchResponse<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aggregations?](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md) | A | (Optional) | -| [page](./kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md) | number | | -| [perPage](./kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md) | number | | -| [total](./kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md) | number | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md deleted file mode 100644 index 77b59c8012a5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [page](./kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md) - -## SavedObjectsFindResponsePublic.page property - -Signature: - -```typescript -page: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md deleted file mode 100644 index b6c6f1a6bff47..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [perPage](./kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md) - -## SavedObjectsFindResponsePublic.perPage property - -Signature: - -```typescript -perPage: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md deleted file mode 100644 index ea551d6be0d7e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) > [total](./kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md) - -## SavedObjectsFindResponsePublic.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md deleted file mode 100644 index 8752120b27c87..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) - -## SavedObjectsImportActionRequiredWarning.actionPath property - -The path (without the basePath) that the user should be redirect to address this warning. - -Signature: - -```typescript -actionPath: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md deleted file mode 100644 index ae7daba4860ef..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [buttonLabel](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md) - -## SavedObjectsImportActionRequiredWarning.buttonLabel property - -An optional label to use for the link button. If unspecified, a default label will be used. - -Signature: - -```typescript -buttonLabel?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md deleted file mode 100644 index fe148fdc2ff1a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) - -## SavedObjectsImportActionRequiredWarning interface - -A warning meant to notify that a specific user action is required to finalize the import of some type of object. - - The `actionUrl` must be a path relative to the basePath, and not include it. - -Signature: - -```typescript -export interface SavedObjectsImportActionRequiredWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [actionPath](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.actionpath.md) | string | The path (without the basePath) that the user should be redirect to address this warning. | -| [buttonLabel?](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.buttonlabel.md) | string | (Optional) An optional label to use for the link button. If unspecified, a default label will be used. | -| [message](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md) | string | The translated message to display to the user. | -| [type](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md) | 'action\_required' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md deleted file mode 100644 index c0f322892577e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [message](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.message.md) - -## SavedObjectsImportActionRequiredWarning.message property - -The translated message to display to the user. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md deleted file mode 100644 index ee88f6a0d5d85..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) > [type](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.type.md) - -## SavedObjectsImportActionRequiredWarning.type property - -Signature: - -```typescript -type: 'action_required'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md deleted file mode 100644 index 59ce43c4bea62..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) > [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md) - -## SavedObjectsImportAmbiguousConflictError.destinations property - -Signature: - -```typescript -destinations: Array<{ - id: string; - title?: string; - updatedAt?: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md deleted file mode 100644 index 2d136bb870de7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) - -## SavedObjectsImportAmbiguousConflictError interface - -Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. - -Signature: - -```typescript -export interface SavedObjectsImportAmbiguousConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md) | Array<{ id: string; title?: string; updatedAt?: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md) | 'ambiguous\_conflict' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md deleted file mode 100644 index 600c56988ac75..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) > [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md) - -## SavedObjectsImportAmbiguousConflictError.type property - -Signature: - -```typescript -type: 'ambiguous_conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md deleted file mode 100644 index ba4002d932f57..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md) - -## SavedObjectsImportConflictError.destinationId property - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md deleted file mode 100644 index 57737986ba4ca..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) - -## SavedObjectsImportConflictError interface - -Represents a failure to import due to a conflict. - -Signature: - -```typescript -export interface SavedObjectsImportConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md) | string | (Optional) | -| [type](./kibana-plugin-core-public.savedobjectsimportconflicterror.type.md) | 'conflict' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md deleted file mode 100644 index 651e230e6de8a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) > [type](./kibana-plugin-core-public.savedobjectsimportconflicterror.type.md) - -## SavedObjectsImportConflictError.type property - -Signature: - -```typescript -type: 'conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md deleted file mode 100644 index 16628e83b8af9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [error](./kibana-plugin-core-public.savedobjectsimportfailure.error.md) - -## SavedObjectsImportFailure.error property - -Signature: - -```typescript -error: SavedObjectsImportConflictError | SavedObjectsImportAmbiguousConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md deleted file mode 100644 index 2279241083241..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [id](./kibana-plugin-core-public.savedobjectsimportfailure.id.md) - -## SavedObjectsImportFailure.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md deleted file mode 100644 index e7de1014bdaf2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) - -## SavedObjectsImportFailure interface - -Represents a failure to import. - -Signature: - -```typescript -export interface SavedObjectsImportFailure -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-public.savedobjectsimportfailure.error.md) | SavedObjectsImportConflictError \| SavedObjectsImportAmbiguousConflictError \| SavedObjectsImportUnsupportedTypeError \| SavedObjectsImportMissingReferencesError \| SavedObjectsImportUnknownError | | -| [id](./kibana-plugin-core-public.savedobjectsimportfailure.id.md) | string | | -| [meta](./kibana-plugin-core-public.savedobjectsimportfailure.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md) | boolean | (Optional) If overwrite is specified, an attempt was made to overwrite an existing object. | -| [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md deleted file mode 100644 index 4ea9455098035..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [meta](./kibana-plugin-core-public.savedobjectsimportfailure.meta.md) - -## SavedObjectsImportFailure.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md deleted file mode 100644 index 579a16697b406..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportfailure.overwrite.md) - -## SavedObjectsImportFailure.overwrite property - -If `overwrite` is specified, an attempt was made to overwrite an existing object. - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md deleted file mode 100644 index 68411093a92ce..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportfailure.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportFailure](./kibana-plugin-core-public.savedobjectsimportfailure.md) > [type](./kibana-plugin-core-public.savedobjectsimportfailure.type.md) - -## SavedObjectsImportFailure.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md deleted file mode 100644 index 6c03ab263084c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) - -## SavedObjectsImportMissingReferencesError interface - -Represents a failure to import due to missing references. - -Signature: - -```typescript -export interface SavedObjectsImportMissingReferencesError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) | Array<{ type: string; id: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) | 'missing\_references' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md deleted file mode 100644 index b479956ed7125..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) > [references](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.references.md) - -## SavedObjectsImportMissingReferencesError.references property - -Signature: - -```typescript -references: Array<{ - type: string; - id: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md deleted file mode 100644 index 6c0caa258c5fb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) > [type](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.type.md) - -## SavedObjectsImportMissingReferencesError.type property - -Signature: - -```typescript -type: 'missing_references'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md deleted file mode 100644 index 073eac20b04ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [errors](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) - -## SavedObjectsImportResponse.errors property - -Signature: - -```typescript -errors?: SavedObjectsImportFailure[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md deleted file mode 100644 index 5b6139723a101..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) - -## SavedObjectsImportResponse interface - -The response describing the result of an import. - -Signature: - -```typescript -export interface SavedObjectsImportResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors?](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) | SavedObjectsImportFailure\[\] | (Optional) | -| [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) | boolean | | -| [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) | number | | -| [successResults?](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) | SavedObjectsImportSuccess\[\] | (Optional) | -| [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) | SavedObjectsImportWarning\[\] | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md deleted file mode 100644 index 3c6492f340418..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.success.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) - -## SavedObjectsImportResponse.success property - -Signature: - -```typescript -success: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md deleted file mode 100644 index caa296c3ef291..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) - -## SavedObjectsImportResponse.successCount property - -Signature: - -```typescript -successCount: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md deleted file mode 100644 index 51a47b6c2d953..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.successresults.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [successResults](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) - -## SavedObjectsImportResponse.successResults property - -Signature: - -```typescript -successResults?: SavedObjectsImportSuccess[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md deleted file mode 100644 index 2e55a2e30f9cb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportresponse.warnings.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) > [warnings](./kibana-plugin-core-public.savedobjectsimportresponse.warnings.md) - -## SavedObjectsImportResponse.warnings property - -Signature: - -```typescript -warnings: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md deleted file mode 100644 index f60c713973d58..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [createNewCopy](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) - -## SavedObjectsImportRetry.createNewCopy property - -If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md deleted file mode 100644 index 5131d1d01ff02..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) - -## SavedObjectsImportRetry.destinationId property - -The object ID that will be created or overwritten. If not specified, the `id` field will be used. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md deleted file mode 100644 index 961c61a2cba6c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) - -## SavedObjectsImportRetry.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md deleted file mode 100644 index 4ce833f2966cc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [ignoreMissingReferences](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) - -## SavedObjectsImportRetry.ignoreMissingReferences property - -If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. - -Signature: - -```typescript -ignoreMissingReferences?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md deleted file mode 100644 index 80a3145ae7e55..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) - -## SavedObjectsImportRetry interface - -Describes a retry operation for importing a saved object. - -Signature: - -```typescript -export interface SavedObjectsImportRetry -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportretry.createnewcopy.md) | boolean | (Optional) If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportretry.destinationid.md) | string | (Optional) The object ID that will be created or overwritten. If not specified, the id field will be used. | -| [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) | string | | -| [ignoreMissingReferences?](./kibana-plugin-core-public.savedobjectsimportretry.ignoremissingreferences.md) | boolean | (Optional) If ignoreMissingReferences is specified, reference validation will be skipped for this object. | -| [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | boolean | | -| [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) | Array<{ type: string; from: string; to: string; }> | | -| [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md deleted file mode 100644 index 51ea151a9cdb3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.overwrite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) - -## SavedObjectsImportRetry.overwrite property - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md deleted file mode 100644 index 2b0fd703c0d81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) - -## SavedObjectsImportRetry.replaceReferences property - -Signature: - -```typescript -replaceReferences: Array<{ - type: string; - from: string; - to: string; - }>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md deleted file mode 100644 index 86ccd13d7ff55..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) > [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) - -## SavedObjectsImportRetry.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md deleted file mode 100644 index 304779a1589f9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) - -## SavedObjectsImportSimpleWarning interface - -A simple informative warning that will be displayed to the user. - -Signature: - -```typescript -export interface SavedObjectsImportSimpleWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) | string | The translated message to display to the user | -| [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) | 'simple' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md deleted file mode 100644 index 42c94e14e3d28..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) > [message](./kibana-plugin-core-public.savedobjectsimportsimplewarning.message.md) - -## SavedObjectsImportSimpleWarning.message property - -The translated message to display to the user - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md deleted file mode 100644 index 86a4cbfa434e7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) > [type](./kibana-plugin-core-public.savedobjectsimportsimplewarning.type.md) - -## SavedObjectsImportSimpleWarning.type property - -Signature: - -```typescript -type: 'simple'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md deleted file mode 100644 index 8867331c1e4b7..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [createNewCopy](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) - -## SavedObjectsImportSuccess.createNewCopy property - -> Warning: This API is now obsolete. -> -> Can be removed when https://github.com/elastic/kibana/issues/91615 is done. If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, this field will be redundant and can be removed. -> - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md deleted file mode 100644 index 55611a77aeb67..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [destinationId](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) - -## SavedObjectsImportSuccess.destinationId property - -If `destinationId` is specified, the new object has a new ID that is different from the import ID. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md deleted file mode 100644 index 6d6271e37dffe..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) - -## SavedObjectsImportSuccess.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md deleted file mode 100644 index 57ca4b7a787f6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) - -## SavedObjectsImportSuccess interface - -Represents a successful import. - -Signature: - -```typescript -export interface SavedObjectsImportSuccess -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-public.savedobjectsimportsuccess.createnewcopy.md) | boolean | (Optional) | -| [destinationId?](./kibana-plugin-core-public.savedobjectsimportsuccess.destinationid.md) | string | (Optional) If destinationId is specified, the new object has a new ID that is different from the import ID. | -| [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) | string | | -| [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) | boolean | (Optional) If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). | -| [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md deleted file mode 100644 index d1c7bc92b5cbf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [meta](./kibana-plugin-core-public.savedobjectsimportsuccess.meta.md) - -## SavedObjectsImportSuccess.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md deleted file mode 100644 index 18ae2ca9bee3d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [overwrite](./kibana-plugin-core-public.savedobjectsimportsuccess.overwrite.md) - -## SavedObjectsImportSuccess.overwrite property - -If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md deleted file mode 100644 index 6ac14455d281f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) > [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) - -## SavedObjectsImportSuccess.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md deleted file mode 100644 index fc78e04dee8ac..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) - -## SavedObjectsImportUnknownError interface - -Represents a failure to import due to an unknown reason. - -Signature: - -```typescript -export interface SavedObjectsImportUnknownError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) | string | | -| [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) | number | | -| [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) | 'unknown' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md deleted file mode 100644 index 4445b3527657f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [message](./kibana-plugin-core-public.savedobjectsimportunknownerror.message.md) - -## SavedObjectsImportUnknownError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md deleted file mode 100644 index 929631cf84b2e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [statusCode](./kibana-plugin-core-public.savedobjectsimportunknownerror.statuscode.md) - -## SavedObjectsImportUnknownError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md deleted file mode 100644 index 9febc279bb093..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunknownerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) > [type](./kibana-plugin-core-public.savedobjectsimportunknownerror.type.md) - -## SavedObjectsImportUnknownError.type property - -Signature: - -```typescript -type: 'unknown'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md deleted file mode 100644 index de805f05a12e9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) - -## SavedObjectsImportUnsupportedTypeError interface - -Represents a failure to import due to having an unsupported saved object type. - -Signature: - -```typescript -export interface SavedObjectsImportUnsupportedTypeError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) | 'unsupported\_type' | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md deleted file mode 100644 index ca8c2a419095f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) > [type](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.type.md) - -## SavedObjectsImportUnsupportedTypeError.type property - -Signature: - -```typescript -type: 'unsupported_type'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md deleted file mode 100644 index a9a9a70774970..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsimportwarning.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsImportWarning](./kibana-plugin-core-public.savedobjectsimportwarning.md) - -## SavedObjectsImportWarning type - -Composite type of all the possible types of import warnings. - -See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-public.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-public.savedobjectsimportactionrequiredwarning.md) for more details. - -Signature: - -```typescript -export declare type SavedObjectsImportWarning = SavedObjectsImportSimpleWarning | SavedObjectsImportActionRequiredWarning; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md deleted file mode 100644 index f1132b98bc84e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsmigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsMigrationVersion](./kibana-plugin-core-public.savedobjectsmigrationversion.md) - -## SavedObjectsMigrationVersion interface - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -export interface SavedObjectsMigrationVersion -``` - -## Example - -migrationVersion: { dashboard: '7.1.1', space: '6.6.6', } - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md deleted file mode 100644 index cf5e6cb29a532..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsnamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsNamespaceType](./kibana-plugin-core-public.savedobjectsnamespacetype.md) - -## SavedObjectsNamespaceType type - -The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. - -Signature: - -```typescript -export declare type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md deleted file mode 100644 index 5e56fe402b10b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [alias\_purpose](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md) - -## SavedObjectsResolveResponse.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md deleted file mode 100644 index 534c5ffde730b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [alias\_target\_id](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md) - -## SavedObjectsResolveResponse.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md deleted file mode 100644 index e212b1ea8b002..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) - -## SavedObjectsResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_purpose.md) | 'savedObjectConversion' \| 'savedObjectImport' | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-public.savedobjectsresolveresponse.alias_target_id.md) | string | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) | SavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md deleted file mode 100644 index ff4367d804e5d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) - -## SavedObjectsResolveResponse.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md deleted file mode 100644 index d8a74d766d582..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) > [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) - -## SavedObjectsResolveResponse.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SavedObject; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md deleted file mode 100644 index 4dc8c5ae41dbc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.client.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) > [client](./kibana-plugin-core-public.savedobjectsstart.client.md) - -## SavedObjectsStart.client property - -[SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) - -Signature: - -```typescript -client: SavedObjectsClientContract; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md deleted file mode 100644 index 774ef2a35a833..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsstart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) - -## SavedObjectsStart interface - - -Signature: - -```typescript -export interface SavedObjectsStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-public.savedobjectsstart.client.md) | SavedObjectsClientContract | [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md deleted file mode 100644 index 4a9b85e7b67e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) - -## SavedObjectsUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references?](./kibana-plugin-core-public.savedobjectsupdateoptions.references.md) | SavedObjectReference\[\] | (Optional) | -| [upsert?](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md) | Attributes | (Optional) | -| [version?](./kibana-plugin-core-public.savedobjectsupdateoptions.version.md) | string | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md deleted file mode 100644 index 87bd774a062a1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [references](./kibana-plugin-core-public.savedobjectsupdateoptions.references.md) - -## SavedObjectsUpdateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md deleted file mode 100644 index 611fd54a527fd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [upsert](./kibana-plugin-core-public.savedobjectsupdateoptions.upsert.md) - -## SavedObjectsUpdateOptions.upsert property - -Signature: - -```typescript -upsert?: Attributes; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md deleted file mode 100644 index d3d90b0c443da..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.savedobjectsupdateoptions.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) > [version](./kibana-plugin-core-public.savedobjectsupdateoptions.version.md) - -## SavedObjectsUpdateOptions.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md deleted file mode 100644 index 67264a26ac5db..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [(constructor)](./kibana-plugin-core-public.scopedhistory._constructor_.md) - -## ScopedHistory.(constructor) - -Constructs a new instance of the `ScopedHistory` class - -Signature: - -```typescript -constructor(parentHistory: History, basePath: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| parentHistory | History<HistoryLocationState> | | -| basePath | string | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md deleted file mode 100644 index 40971b6617dce..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [action](./kibana-plugin-core-public.scopedhistory.action.md) - -## ScopedHistory.action property - -The last action dispatched on the history stack. - -Signature: - -```typescript -get action(): Action; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md deleted file mode 100644 index acbb06c6aa6ec..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.block.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [block](./kibana-plugin-core-public.scopedhistory.block.md) - -## ScopedHistory.block property - -Add a block prompt requesting user confirmation when navigating away from the current page. - -Signature: - -```typescript -block: (prompt?: string | boolean | TransitionPromptHook | undefined) => UnregisterCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md deleted file mode 100644 index 5ab31c0ba6ff2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) - -## ScopedHistory.createHref property - -Creates an href (string) to the location. If `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath. - -Signature: - -```typescript -createHref: (location: LocationDescriptorObject, { prependBasePath }?: { - prependBasePath?: boolean | undefined; - }) => Href; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md deleted file mode 100644 index 7c5dfccb5b008..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.createsubhistory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) - -## ScopedHistory.createSubHistory property - -Creates a `ScopedHistory` for a subpath of this `ScopedHistory`. Useful for applications that may have sub-apps that do not need access to the containing application's history. - -Signature: - -```typescript -createSubHistory: (basePath: string) => ScopedHistory; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md deleted file mode 100644 index 33d3e94c9171d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.go.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [go](./kibana-plugin-core-public.scopedhistory.go.md) - -## ScopedHistory.go property - -Send the user forward or backwards in the history stack. - -Signature: - -```typescript -go: (n: number) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md deleted file mode 100644 index ba32ac45d4b5a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) - -## ScopedHistory.goBack property - -Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available backwards, this is a no-op. - -Signature: - -```typescript -goBack: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md deleted file mode 100644 index 9918cb0407cd8..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.goforward.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [goForward](./kibana-plugin-core-public.scopedhistory.goforward.md) - -## ScopedHistory.goForward property - -Send the user one location forward in the history stack. Equivalent to calling [ScopedHistory.go(1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available forwards, this is a no-op. - -Signature: - -```typescript -goForward: () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md deleted file mode 100644 index 0205261b57539..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.length.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [length](./kibana-plugin-core-public.scopedhistory.length.md) - -## ScopedHistory.length property - -The number of entries in the history stack, including all entries forwards and backwards from the current location. - -Signature: - -```typescript -get length(): number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md deleted file mode 100644 index febf88639b67c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.listen.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [listen](./kibana-plugin-core-public.scopedhistory.listen.md) - -## ScopedHistory.listen property - -Adds a listener for location updates. - -Signature: - -```typescript -listen: (listener: (location: Location, action: Action) => void) => UnregisterCallback; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md deleted file mode 100644 index 45227a2b15ad0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.location.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [location](./kibana-plugin-core-public.scopedhistory.location.md) - -## ScopedHistory.location property - -The current location of the history stack. - -Signature: - -```typescript -get location(): Location; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md deleted file mode 100644 index a3c369b143b4a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.md +++ /dev/null @@ -1,42 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) - -## ScopedHistory class - -A wrapper around a `History` instance that is scoped to a particular base path of the history stack. Behaves similarly to the `basename` option except that this wrapper hides any history stack entries from outside the scope of this base path. - -This wrapper also allows Core and Plugins to share a single underlying global `History` instance without exposing the history of other applications. - -The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. - -Signature: - -```typescript -export declare class ScopedHistory implements History -``` -Implements: History<HistoryLocationState> - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(parentHistory, basePath)](./kibana-plugin-core-public.scopedhistory._constructor_.md) | | Constructs a new instance of the ScopedHistory class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [action](./kibana-plugin-core-public.scopedhistory.action.md) | | Action | The last action dispatched on the history stack. | -| [block](./kibana-plugin-core-public.scopedhistory.block.md) | | (prompt?: string \| boolean \| TransitionPromptHook<HistoryLocationState> \| undefined) => UnregisterCallback | Add a block prompt requesting user confirmation when navigating away from the current page. | -| [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) | | (location: LocationDescriptorObject<HistoryLocationState>, { prependBasePath }?: { prependBasePath?: boolean \| undefined; }) => Href | Creates an href (string) to the location. If prependBasePath is true (default), it will prepend the location's path with the scoped history basePath. | -| [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) | | (basePath: string) => ScopedHistory<HistoryLocationState> | Creates a ScopedHistory for a subpath of this ScopedHistory. Useful for applications that may have sub-apps that do not need access to the containing application's history. | -| [go](./kibana-plugin-core-public.scopedhistory.go.md) | | (n: number) => void | Send the user forward or backwards in the history stack. | -| [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) | | () => void | Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available backwards, this is a no-op. | -| [goForward](./kibana-plugin-core-public.scopedhistory.goforward.md) | | () => void | Send the user one location forward in the history stack. Equivalent to calling [ScopedHistory.go(1)](./kibana-plugin-core-public.scopedhistory.go.md). If no more entries are available forwards, this is a no-op. | -| [length](./kibana-plugin-core-public.scopedhistory.length.md) | | number | The number of entries in the history stack, including all entries forwards and backwards from the current location. | -| [listen](./kibana-plugin-core-public.scopedhistory.listen.md) | | (listener: (location: Location<HistoryLocationState>, action: Action) => void) => UnregisterCallback | Adds a listener for location updates. | -| [location](./kibana-plugin-core-public.scopedhistory.location.md) | | Location<HistoryLocationState> | The current location of the history stack. | -| [push](./kibana-plugin-core-public.scopedhistory.push.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. | -| [replace](./kibana-plugin-core-public.scopedhistory.replace.md) | | (pathOrLocation: Path \| LocationDescriptorObject<HistoryLocationState>, state?: HistoryLocationState \| undefined) => void | Replaces the current location in the history stack. Does not remove forward or backward entries. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md deleted file mode 100644 index 226203502c5e0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.push.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [push](./kibana-plugin-core-public.scopedhistory.push.md) - -## ScopedHistory.push property - -Pushes a new location onto the history stack. If there are forward entries in the stack, they will be removed. - -Signature: - -```typescript -push: (pathOrLocation: Path | LocationDescriptorObject, state?: HistoryLocationState | undefined) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md b/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md deleted file mode 100644 index 545c81ead0984..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.scopedhistory.replace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) > [replace](./kibana-plugin-core-public.scopedhistory.replace.md) - -## ScopedHistory.replace property - -Replaces the current location in the history stack. Does not remove forward or backward entries. - -Signature: - -```typescript -replace: (pathOrLocation: Path | LocationDescriptorObject, state?: HistoryLocationState | undefined) => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md deleted file mode 100644 index 412154f7ac2e3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [(constructor)](./kibana-plugin-core-public.simplesavedobject._constructor_.md) - -## SimpleSavedObject.(constructor) - -Constructs a new instance of the `SimpleSavedObject` class - -Signature: - -```typescript -constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated_at: updatedAt, }: SavedObjectType); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| client | SavedObjectsClientContract | | -| { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated\_at: updatedAt, } | SavedObjectType<T> | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md deleted file mode 100644 index 2e5d708143c5e..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [\_version](./kibana-plugin-core-public.simplesavedobject._version.md) - -## SimpleSavedObject.\_version property - -Signature: - -```typescript -_version?: SavedObjectType['version']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md deleted file mode 100644 index cdca741c10adc..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [attributes](./kibana-plugin-core-public.simplesavedobject.attributes.md) - -## SimpleSavedObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md deleted file mode 100644 index 8e2217fab6eee..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.coremigrationversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) - -## SimpleSavedObject.coreMigrationVersion property - -Signature: - -```typescript -coreMigrationVersion: SavedObjectType['coreMigrationVersion']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md deleted file mode 100644 index cb848bff56430..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.delete.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [delete](./kibana-plugin-core-public.simplesavedobject.delete.md) - -## SimpleSavedObject.delete() method - -Signature: - -```typescript -delete(): Promise<{}>; -``` -Returns: - -Promise<{}> - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md deleted file mode 100644 index 326b255272582..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [error](./kibana-plugin-core-public.simplesavedobject.error.md) - -## SimpleSavedObject.error property - -Signature: - -```typescript -error: SavedObjectType['error']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md deleted file mode 100644 index 9a9c27d78c06c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.get.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [get](./kibana-plugin-core-public.simplesavedobject.get.md) - -## SimpleSavedObject.get() method - -Signature: - -```typescript -get(key: string): any; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | - -Returns: - -any - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md deleted file mode 100644 index acd0ff02c7d23..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.has.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [has](./kibana-plugin-core-public.simplesavedobject.has.md) - -## SimpleSavedObject.has() method - -Signature: - -```typescript -has(key: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | - -Returns: - -boolean - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md deleted file mode 100644 index 92c560f661e96..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [id](./kibana-plugin-core-public.simplesavedobject.id.md) - -## SimpleSavedObject.id property - -Signature: - -```typescript -id: SavedObjectType['id']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md deleted file mode 100644 index f151dc8bb5e09..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.md +++ /dev/null @@ -1,47 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) - -## SimpleSavedObject class - -This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClientContract](./kibana-plugin-core-public.savedobjectsclientcontract.md). - -It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. - -Signature: - -```typescript -export declare class SimpleSavedObject -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, updated\_at: updatedAt, })](./kibana-plugin-core-public.simplesavedobject._constructor_.md) | | Constructs a new instance of the SimpleSavedObject class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_version?](./kibana-plugin-core-public.simplesavedobject._version.md) | | SavedObjectType<T>\['version'\] | (Optional) | -| [attributes](./kibana-plugin-core-public.simplesavedobject.attributes.md) | | T | | -| [coreMigrationVersion](./kibana-plugin-core-public.simplesavedobject.coremigrationversion.md) | | SavedObjectType<T>\['coreMigrationVersion'\] | | -| [error](./kibana-plugin-core-public.simplesavedobject.error.md) | | SavedObjectType<T>\['error'\] | | -| [id](./kibana-plugin-core-public.simplesavedobject.id.md) | | SavedObjectType<T>\['id'\] | | -| [migrationVersion](./kibana-plugin-core-public.simplesavedobject.migrationversion.md) | | SavedObjectType<T>\['migrationVersion'\] | | -| [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md) | | SavedObjectType<T>\['namespaces'\] | Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [references](./kibana-plugin-core-public.simplesavedobject.references.md) | | SavedObjectType<T>\['references'\] | | -| [type](./kibana-plugin-core-public.simplesavedobject.type.md) | | SavedObjectType<T>\['type'\] | | -| [updatedAt](./kibana-plugin-core-public.simplesavedobject.updatedat.md) | | SavedObjectType<T>\['updated\_at'\] | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [delete()](./kibana-plugin-core-public.simplesavedobject.delete.md) | | | -| [get(key)](./kibana-plugin-core-public.simplesavedobject.get.md) | | | -| [has(key)](./kibana-plugin-core-public.simplesavedobject.has.md) | | | -| [save()](./kibana-plugin-core-public.simplesavedobject.save.md) | | | -| [set(key, value)](./kibana-plugin-core-public.simplesavedobject.set.md) | | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md deleted file mode 100644 index a5d17f72513a2..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.migrationversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [migrationVersion](./kibana-plugin-core-public.simplesavedobject.migrationversion.md) - -## SimpleSavedObject.migrationVersion property - -Signature: - -```typescript -migrationVersion: SavedObjectType['migrationVersion']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md deleted file mode 100644 index 7fb0a4e3a717a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md) - -## SimpleSavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces: SavedObjectType['namespaces']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md deleted file mode 100644 index 805309a151105..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [references](./kibana-plugin-core-public.simplesavedobject.references.md) - -## SimpleSavedObject.references property - -Signature: - -```typescript -references: SavedObjectType['references']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md deleted file mode 100644 index fdd262c70d4e6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.save.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [save](./kibana-plugin-core-public.simplesavedobject.save.md) - -## SimpleSavedObject.save() method - -Signature: - -```typescript -save(): Promise>; -``` -Returns: - -Promise<SimpleSavedObject<T>> - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md deleted file mode 100644 index e3a6621f520bd..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.set.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [set](./kibana-plugin-core-public.simplesavedobject.set.md) - -## SimpleSavedObject.set() method - -Signature: - -```typescript -set(key: string, value: any): T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| key | string | | -| value | any | | - -Returns: - -T - diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md deleted file mode 100644 index ce5874bc3e0cf..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [type](./kibana-plugin-core-public.simplesavedobject.type.md) - -## SimpleSavedObject.type property - -Signature: - -```typescript -type: SavedObjectType['type']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md b/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md deleted file mode 100644 index 80b1f95969934..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.simplesavedobject.updatedat.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) > [updatedAt](./kibana-plugin-core-public.simplesavedobject.updatedat.md) - -## SimpleSavedObject.updatedAt property - -Signature: - -```typescript -updatedAt: SavedObjectType['updated_at']; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md b/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md deleted file mode 100644 index ad53307d53d69..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.startservicesaccessor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) - -## StartServicesAccessor type - -Allows plugins to get access to APIs available in start inside async handlers, such as [App.mount](./kibana-plugin-core-public.app.mount.md). Promise will not resolve until Core and plugin dependencies have completed `start`. - -Signature: - -```typescript -export declare type StartServicesAccessor = () => Promise<[CoreStart, TPluginsStart, TStart]>; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toast.md b/docs/development/core/public/kibana-plugin-core-public.toast.md deleted file mode 100644 index 4acdfa4763d9c..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toast.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [Toast](./kibana-plugin-core-public.toast.md) - -## Toast type - -Signature: - -```typescript -export declare type Toast = ToastInputFields & { - id: string; -}; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastinput.md b/docs/development/core/public/kibana-plugin-core-public.toastinput.md deleted file mode 100644 index c6e58227293b6..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastinput.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastInput](./kibana-plugin-core-public.toastinput.md) - -## ToastInput type - -Inputs for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. - -Signature: - -```typescript -export declare type ToastInput = string | ToastInputFields; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md b/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md deleted file mode 100644 index 4eed737726835..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastinputfields.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastInputFields](./kibana-plugin-core-public.toastinputfields.md) - -## ToastInputFields type - -Allowed fields for [ToastInput](./kibana-plugin-core-public.toastinput.md). - -Signature: - -```typescript -export declare type ToastInputFields = Pick> & { - title?: string | MountPoint; - text?: string | MountPoint; -}; -``` - -## Remarks - -`id` cannot be specified. - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastoptions.md b/docs/development/core/public/kibana-plugin-core-public.toastoptions.md deleted file mode 100644 index c140a2e52b036..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) - -## ToastOptions interface - -Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. - -Signature: - -```typescript -export interface ToastOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toastLifeTimeMs?](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) | number | (Optional) How long should the toast remain on screen. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md b/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md deleted file mode 100644 index bb0e2f9afc83b..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) > [toastLifeTimeMs](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) - -## ToastOptions.toastLifeTimeMs property - -How long should the toast remain on screen. - -Signature: - -```typescript -toastLifeTimeMs?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md deleted file mode 100644 index c50cc4d6469ea..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [(constructor)](./kibana-plugin-core-public.toastsapi._constructor_.md) - -## ToastsApi.(constructor) - -Constructs a new instance of the `ToastsApi` class - -Signature: - -```typescript -constructor(deps: { - uiSettings: IUiSettingsClient; - }); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| deps | { uiSettings: IUiSettingsClient; } | | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md deleted file mode 100644 index 7bee5af0c3be4..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.add.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [add](./kibana-plugin-core-public.toastsapi.add.md) - -## ToastsApi.add() method - -Adds a new toast to current array of toast. - -Signature: - -```typescript -add(toastOrTitle: ToastInput): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md deleted file mode 100644 index f73a84996ff92..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adddanger.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addDanger](./kibana-plugin-core-public.toastsapi.adddanger.md) - -## ToastsApi.addDanger() method - -Adds a new toast pre-configured with the danger color and alert icon. - -Signature: - -```typescript -addDanger(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md deleted file mode 100644 index c1520ea392f70..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.adderror.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addError](./kibana-plugin-core-public.toastsapi.adderror.md) - -## ToastsApi.addError() method - -Adds a new toast that displays an exception message with a button to open the full stacktrace in a modal. - -Signature: - -```typescript -addError(error: Error, options: ErrorToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | an Error instance. | -| options | ErrorToastOptions | [ErrorToastOptions](./kibana-plugin-core-public.errortoastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md deleted file mode 100644 index 7029482663155..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addInfo](./kibana-plugin-core-public.toastsapi.addinfo.md) - -## ToastsApi.addInfo() method - -Adds a new toast pre-configured with the info color and info icon. - -Signature: - -```typescript -addInfo(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md deleted file mode 100644 index b9cf4da3b43af..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addsuccess.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addSuccess](./kibana-plugin-core-public.toastsapi.addsuccess.md) - -## ToastsApi.addSuccess() method - -Adds a new toast pre-configured with the success color and check icon. - -Signature: - -```typescript -addSuccess(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md deleted file mode 100644 index 790af0d26220a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.addwarning.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addWarning](./kibana-plugin-core-public.toastsapi.addwarning.md) - -## ToastsApi.addWarning() method - -Adds a new toast pre-configured with the warning color and help icon. - -Signature: - -```typescript -addWarning(toastOrTitle: ToastInput, options?: ToastOptions): Toast; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrTitle | ToastInput | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | -| options | ToastOptions | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | - -Returns: - -Toast - -a [Toast](./kibana-plugin-core-public.toast.md) - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md deleted file mode 100644 index 275d30fd54e0f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.get_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [get$](./kibana-plugin-core-public.toastsapi.get_.md) - -## ToastsApi.get$() method - -Observable of the toast messages to show to the user. - -Signature: - -```typescript -get$(): Rx.Observable; -``` -Returns: - -Rx.Observable<Toast\[\]> - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.md deleted file mode 100644 index 4d7f9dcacfa6f..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) - -## ToastsApi class - -Methods for adding and removing global toast messages. - -Signature: - -```typescript -export declare class ToastsApi implements IToasts -``` -Implements: IToasts - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(deps)](./kibana-plugin-core-public.toastsapi._constructor_.md) | | Constructs a new instance of the ToastsApi class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [add(toastOrTitle)](./kibana-plugin-core-public.toastsapi.add.md) | | Adds a new toast to current array of toast. | -| [addDanger(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.adddanger.md) | | Adds a new toast pre-configured with the danger color and alert icon. | -| [addError(error, options)](./kibana-plugin-core-public.toastsapi.adderror.md) | | Adds a new toast that displays an exception message with a button to open the full stacktrace in a modal. | -| [addInfo(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addinfo.md) | | Adds a new toast pre-configured with the info color and info icon. | -| [addSuccess(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addsuccess.md) | | Adds a new toast pre-configured with the success color and check icon. | -| [addWarning(toastOrTitle, options)](./kibana-plugin-core-public.toastsapi.addwarning.md) | | Adds a new toast pre-configured with the warning color and help icon. | -| [get$()](./kibana-plugin-core-public.toastsapi.get_.md) | | Observable of the toast messages to show to the user. | -| [remove(toastOrId)](./kibana-plugin-core-public.toastsapi.remove.md) | | Removes a toast from the current array of toasts if present. | - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md b/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md deleted file mode 100644 index aeac9f46b7901..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsapi.remove.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [remove](./kibana-plugin-core-public.toastsapi.remove.md) - -## ToastsApi.remove() method - -Removes a toast from the current array of toasts if present. - -Signature: - -```typescript -remove(toastOrId: Toast | string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| toastOrId | Toast \| string | a [Toast](./kibana-plugin-core-public.toast.md) returned by [ToastsApi.add()](./kibana-plugin-core-public.toastsapi.add.md) or its id | - -Returns: - -void - diff --git a/docs/development/core/public/kibana-plugin-core-public.toastssetup.md b/docs/development/core/public/kibana-plugin-core-public.toastssetup.md deleted file mode 100644 index c704a3ec1d80a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastssetup.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsSetup](./kibana-plugin-core-public.toastssetup.md) - -## ToastsSetup type - -[IToasts](./kibana-plugin-core-public.itoasts.md) - -Signature: - -```typescript -export declare type ToastsSetup = IToasts; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.toastsstart.md b/docs/development/core/public/kibana-plugin-core-public.toastsstart.md deleted file mode 100644 index 3b2cf97e4ddf0..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.toastsstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsStart](./kibana-plugin-core-public.toastsstart.md) - -## ToastsStart type - -[IToasts](./kibana-plugin-core-public.itoasts.md) - -Signature: - -```typescript -export declare type ToastsStart = IToasts; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md deleted file mode 100644 index 4b67d32e6bc27..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [category](./kibana-plugin-core-public.uisettingsparams.category.md) - -## UiSettingsParams.category property - -used to group the configured setting in the UI - -Signature: - -```typescript -category?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md deleted file mode 100644 index a68cbed7662e3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.deprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) - -## UiSettingsParams.deprecation property - -optional deprecation information. Used to generate a deprecation warning. - -Signature: - -```typescript -deprecation?: DeprecationSettings; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md deleted file mode 100644 index 25e616dbaa90a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [description](./kibana-plugin-core-public.uisettingsparams.description.md) - -## UiSettingsParams.description property - -description provided to a user in UI - -Signature: - -```typescript -description?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md deleted file mode 100644 index 325ce96f36ca3..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) - -## UiSettingsParams interface - -UiSettings parameters defined by the plugins. - -Signature: - -```typescript -export interface UiSettingsParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./kibana-plugin-core-public.uisettingsparams.category.md) | string\[\] | (Optional) used to group the configured setting in the UI | -| [deprecation?](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | DeprecationSettings | (Optional) optional deprecation information. Used to generate a deprecation warning. | -| [description?](./kibana-plugin-core-public.uisettingsparams.description.md) | string | (Optional) description provided to a user in UI | -| [metric?](./kibana-plugin-core-public.uisettingsparams.metric.md) | { type: UiCounterMetricType; name: string; } | (Optional) Metric to track once this property changes | -| [name?](./kibana-plugin-core-public.uisettingsparams.name.md) | string | (Optional) title in the UI | -| [optionLabels?](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | Record<string, string> | (Optional) text labels for 'select' type UI element | -| [options?](./kibana-plugin-core-public.uisettingsparams.options.md) | string\[\] | (Optional) array of permitted values for this setting | -| [order?](./kibana-plugin-core-public.uisettingsparams.order.md) | number | (Optional) index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. settings without order defined will be displayed last and ordered by name | -| [readonly?](./kibana-plugin-core-public.uisettingsparams.readonly.md) | boolean | (Optional) a flag indicating that value cannot be changed | -| [requiresPageReload?](./kibana-plugin-core-public.uisettingsparams.requirespagereload.md) | boolean | (Optional) a flag indicating whether new value applying requires page reloading | -| [schema](./kibana-plugin-core-public.uisettingsparams.schema.md) | Type<T> | | -| [sensitive?](./kibana-plugin-core-public.uisettingsparams.sensitive.md) | boolean | (Optional) a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. | -| [type?](./kibana-plugin-core-public.uisettingsparams.type.md) | UiSettingsType | (Optional) defines a type of UI element [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) | -| [value?](./kibana-plugin-core-public.uisettingsparams.value.md) | T | (Optional) default value to fall back to if a user doesn't provide any | - diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md deleted file mode 100644 index c6d288ec8f542..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) - -## UiSettingsParams.metric property - -> Warning: This API is now obsolete. -> -> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place -> - -Metric to track once this property changes - -Signature: - -```typescript -metric?: { - type: UiCounterMetricType; - name: string; - }; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md deleted file mode 100644 index a86ba4d49725a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [name](./kibana-plugin-core-public.uisettingsparams.name.md) - -## UiSettingsParams.name property - -title in the UI - -Signature: - -```typescript -name?: string; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md deleted file mode 100644 index 35e90878a0dab..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.optionlabels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) - -## UiSettingsParams.optionLabels property - -text labels for 'select' type UI element - -Signature: - -```typescript -optionLabels?: Record; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md deleted file mode 100644 index 60060d7c3223d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [options](./kibana-plugin-core-public.uisettingsparams.options.md) - -## UiSettingsParams.options property - -array of permitted values for this setting - -Signature: - -```typescript -options?: string[]; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md deleted file mode 100644 index d93aaeb904616..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.order.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [order](./kibana-plugin-core-public.uisettingsparams.order.md) - -## UiSettingsParams.order property - -index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. - - settings without order defined will be displayed last and ordered by name - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md deleted file mode 100644 index 03c5cd6201825..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.readonly.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [readonly](./kibana-plugin-core-public.uisettingsparams.readonly.md) - -## UiSettingsParams.readonly property - -a flag indicating that value cannot be changed - -Signature: - -```typescript -readonly?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md deleted file mode 100644 index 2ce396dbc6a81..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.requirespagereload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [requiresPageReload](./kibana-plugin-core-public.uisettingsparams.requirespagereload.md) - -## UiSettingsParams.requiresPageReload property - -a flag indicating whether new value applying requires page reloading - -Signature: - -```typescript -requiresPageReload?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md deleted file mode 100644 index f90d5161f96a9..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.schema.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [schema](./kibana-plugin-core-public.uisettingsparams.schema.md) - -## UiSettingsParams.schema property - -Signature: - -```typescript -schema: Type; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md deleted file mode 100644 index e12f3c5649f17..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.sensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [sensitive](./kibana-plugin-core-public.uisettingsparams.sensitive.md) - -## UiSettingsParams.sensitive property - -a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. - -Signature: - -```typescript -sensitive?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md deleted file mode 100644 index 128e8f3ce7761..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [type](./kibana-plugin-core-public.uisettingsparams.type.md) - -## UiSettingsParams.type property - -defines a type of UI element [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) - -Signature: - -```typescript -type?: UiSettingsType; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md deleted file mode 100644 index 2740f169eeecb..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsparams.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md) > [value](./kibana-plugin-core-public.uisettingsparams.value.md) - -## UiSettingsParams.value property - -default value to fall back to if a user doesn't provide any - -Signature: - -```typescript -value?: T; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md b/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md deleted file mode 100644 index 8aae7904276e1..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingsstate.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsState](./kibana-plugin-core-public.uisettingsstate.md) - -## UiSettingsState interface - - -Signature: - -```typescript -export interface UiSettingsState -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md b/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md deleted file mode 100644 index 65e6264ea1e08..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.uisettingstype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UiSettingsType](./kibana-plugin-core-public.uisettingstype.md) - -## UiSettingsType type - -UI element type to represent the settings. - -Signature: - -```typescript -export declare type UiSettingsType = 'undefined' | 'json' | 'markdown' | 'number' | 'select' | 'boolean' | 'string' | 'array' | 'image' | 'color'; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md b/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md deleted file mode 100644 index e4570de5a0f31..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.unmountcallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UnmountCallback](./kibana-plugin-core-public.unmountcallback.md) - -## UnmountCallback type - -A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-core-public.mountpoint.md) - -Signature: - -```typescript -export declare type UnmountCallback = () => void; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.url_max_length.md b/docs/development/core/public/kibana-plugin-core-public.url_max_length.md deleted file mode 100644 index 993320d51909a..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.url_max_length.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md) - -## URL\_MAX\_LENGTH variable - -The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit. - -Signature: - -```typescript -URL_MAX_LENGTH: number -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md deleted file mode 100644 index 2d9994e442f00..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.isoverridden.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) > [isOverridden](./kibana-plugin-core-public.userprovidedvalues.isoverridden.md) - -## UserProvidedValues.isOverridden property - -Signature: - -```typescript -isOverridden?: boolean; -``` diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md deleted file mode 100644 index eb8f0124c3341..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) - -## UserProvidedValues interface - -Describes the values explicitly set by user. - -Signature: - -```typescript -export interface UserProvidedValues -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isOverridden?](./kibana-plugin-core-public.userprovidedvalues.isoverridden.md) | boolean | (Optional) | -| [userValue?](./kibana-plugin-core-public.userprovidedvalues.uservalue.md) | T | (Optional) | - diff --git a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md b/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md deleted file mode 100644 index 8925852f6e80d..0000000000000 --- a/docs/development/core/public/kibana-plugin-core-public.userprovidedvalues.uservalue.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) > [userValue](./kibana-plugin-core-public.userprovidedvalues.uservalue.md) - -## UserProvidedValues.userValue property - -Signature: - -```typescript -userValue?: T; -``` diff --git a/docs/development/core/server/index.md b/docs/development/core/server/index.md deleted file mode 100644 index 2f215c322cdc8..0000000000000 --- a/docs/development/core/server/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [kibana-plugin-core-server](./kibana-plugin-core-server.md) | The Kibana Core APIs for server-side plugins.A plugin requires a kibana.json file at it's root directory that follows to define static plugin information required to load the plugin.A plugin's server/index file must contain a named import, plugin, that implements which returns an object that implements .The plugin integrates with the core system via lifecycle events: setup, start, and stop. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md deleted file mode 100644 index e1129181dbb49..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicepreboot.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) - -## AnalyticsServicePreboot type - -Exposes the public APIs of the AnalyticsClient during the preboot phase - -Signature: - -```typescript -export declare type AnalyticsServicePreboot = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md deleted file mode 100644 index 5dc90eb0c1f03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicesetup.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) - -## AnalyticsServiceSetup type - -Exposes the public APIs of the AnalyticsClient during the setup phase. - -Signature: - -```typescript -export declare type AnalyticsServiceSetup = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md deleted file mode 100644 index 828577889da61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.analyticsservicestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) - -## AnalyticsServiceStart type - -Exposes the public APIs of the AnalyticsClient during the start phase - -Signature: - -```typescript -export declare type AnalyticsServiceStart = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md b/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md deleted file mode 100644 index cdb0b909bf79d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.app_wrapper_class.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [APP\_WRAPPER\_CLASS](./kibana-plugin-core-server.app_wrapper_class.md) - -## APP\_WRAPPER\_CLASS variable - -The class name for top level \*and\* nested application wrappers to ensure proper layout - -Signature: - -```typescript -APP_WRAPPER_CLASS = "kbnAppWrapper" -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md deleted file mode 100644 index fe81f7cffaa41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.arialabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [ariaLabel](./kibana-plugin-core-server.appcategory.arialabel.md) - -## AppCategory.ariaLabel property - -If the visual label isn't appropriate for screen readers, can override it here - -Signature: - -```typescript -ariaLabel?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md deleted file mode 100644 index 79de37ea619f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.euiicontype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [euiIconType](./kibana-plugin-core-server.appcategory.euiicontype.md) - -## AppCategory.euiIconType property - -Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined - -Signature: - -```typescript -euiIconType?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md deleted file mode 100644 index f0889d200725a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [id](./kibana-plugin-core-server.appcategory.id.md) - -## AppCategory.id property - -Unique identifier for the categories - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md deleted file mode 100644 index 9405118ed7a11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.label.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [label](./kibana-plugin-core-server.appcategory.label.md) - -## AppCategory.label property - -Label used for category name. Also used as aria-label if one isn't set. - -Signature: - -```typescript -label: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.md deleted file mode 100644 index ca5e8b354d451..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) - -## AppCategory interface - -A category definition for nav links to know where to sort them in the left hand nav - -Signature: - -```typescript -export interface AppCategory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [ariaLabel?](./kibana-plugin-core-server.appcategory.arialabel.md) | string | (Optional) If the visual label isn't appropriate for screen readers, can override it here | -| [euiIconType?](./kibana-plugin-core-server.appcategory.euiicontype.md) | string | (Optional) Define an icon to be used for the category If the category is only 1 item, and no icon is defined, will default to the product icon Defaults to initials if no icon is defined | -| [id](./kibana-plugin-core-server.appcategory.id.md) | string | Unique identifier for the categories | -| [label](./kibana-plugin-core-server.appcategory.label.md) | string | Label used for category name. Also used as aria-label if one isn't set. | -| [order?](./kibana-plugin-core-server.appcategory.order.md) | number | (Optional) The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md b/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md deleted file mode 100644 index aba1b886076ad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.appcategory.order.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AppCategory](./kibana-plugin-core-server.appcategory.md) > [order](./kibana-plugin-core-server.appcategory.order.md) - -## AppCategory.order property - -The order that categories will be sorted in Prefer large steps between categories to allow for further editing (Default categories are in steps of 1000) - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md deleted file mode 100644 index bd528e59878ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) - -## AsyncPlugin interface - -> Warning: This API is now obsolete. -> -> Asynchronous lifecycles are deprecated, and should be migrated to sync 8.8.0 -> - -A plugin with asynchronous lifecycle methods. - -Signature: - -```typescript -export interface AsyncPlugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.asyncplugin.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-server.asyncplugin.start.md) | | -| [stop()?](./kibana-plugin-core-server.asyncplugin.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md deleted file mode 100644 index 73752d6c9bd20..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [setup](./kibana-plugin-core-server.asyncplugin.setup.md) - -## AsyncPlugin.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup \| Promise<TSetup> - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md deleted file mode 100644 index 98cf74341062a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [start](./kibana-plugin-core-server.asyncplugin.start.md) - -## AsyncPlugin.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart | Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart \| Promise<TStart> - diff --git a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md b/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md deleted file mode 100644 index 80c554f343346..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.asyncplugin.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) > [stop](./kibana-plugin-core-server.asyncplugin.stop.md) - -## AsyncPlugin.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticated.md b/docs/development/core/server/kibana-plugin-core-server.authenticated.md deleted file mode 100644 index 90b480d4a026c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticated.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Authenticated](./kibana-plugin-core-server.authenticated.md) - -## Authenticated interface - - -Signature: - -```typescript -export interface Authenticated extends AuthResultParams -``` -Extends: AuthResultParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authenticated.type.md) | AuthResultType.authenticated | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md b/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md deleted file mode 100644 index f655ecac12606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticated.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Authenticated](./kibana-plugin-core-server.authenticated.md) > [type](./kibana-plugin-core-server.authenticated.type.md) - -## Authenticated.type property - -Signature: - -```typescript -type: AuthResultType.authenticated; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md b/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md deleted file mode 100644 index d7a456dc127af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authenticationhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md) - -## AuthenticationHandler type - -See [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md). - -Signature: - -```typescript -export declare type AuthenticationHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: AuthToolkit) => AuthResult | IKibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authheaders.md b/docs/development/core/server/kibana-plugin-core-server.authheaders.md deleted file mode 100644 index 60c3c0be7e552..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthHeaders](./kibana-plugin-core-server.authheaders.md) - -## AuthHeaders type - -Auth Headers map - -Signature: - -```typescript -export declare type AuthHeaders = Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authnothandled.md b/docs/development/core/server/kibana-plugin-core-server.authnothandled.md deleted file mode 100644 index 297f60e4bd8ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authnothandled.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) - -## AuthNotHandled interface - - -Signature: - -```typescript -export interface AuthNotHandled -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authnothandled.type.md) | AuthResultType.notHandled | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md b/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md deleted file mode 100644 index 0e328b704153d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authnothandled.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) > [type](./kibana-plugin-core-server.authnothandled.type.md) - -## AuthNotHandled.type property - -Signature: - -```typescript -type: AuthResultType.notHandled; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirected.md b/docs/development/core/server/kibana-plugin-core-server.authredirected.md deleted file mode 100644 index 4da08e49056f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirected.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirected](./kibana-plugin-core-server.authredirected.md) - -## AuthRedirected interface - - -Signature: - -```typescript -export interface AuthRedirected extends AuthRedirectedParams -``` -Extends: AuthRedirectedParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.authredirected.type.md) | AuthResultType.redirected | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md b/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md deleted file mode 100644 index b906656818b85..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirected.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirected](./kibana-plugin-core-server.authredirected.md) > [type](./kibana-plugin-core-server.authredirected.type.md) - -## AuthRedirected.type property - -Signature: - -```typescript -type: AuthResultType.redirected; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md b/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md deleted file mode 100644 index b500e0c494f61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.headers.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) > [headers](./kibana-plugin-core-server.authredirectedparams.headers.md) - -## AuthRedirectedParams.headers property - -Headers to attach for auth redirect. Must include "location" header - -Signature: - -```typescript -headers: { - location: string; - } & ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md b/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md deleted file mode 100644 index 2f6ef7c6f6ba4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authredirectedparams.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) - -## AuthRedirectedParams interface - -Result of auth redirection. - -Signature: - -```typescript -export interface AuthRedirectedParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers](./kibana-plugin-core-server.authredirectedparams.headers.md) | { location: string; } & ResponseHeaders | Headers to attach for auth redirect. Must include "location" header | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authresult.md b/docs/development/core/server/kibana-plugin-core-server.authresult.md deleted file mode 100644 index e523353d83f4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresult.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResult](./kibana-plugin-core-server.authresult.md) - -## AuthResult type - - -Signature: - -```typescript -export declare type AuthResult = Authenticated | AuthNotHandled | AuthRedirected; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.md deleted file mode 100644 index 7e907a9bf7a77..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) - -## AuthResultParams interface - -Result of successful authentication. - -Signature: - -```typescript -export interface AuthResultParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [requestHeaders?](./kibana-plugin-core-server.authresultparams.requestheaders.md) | AuthHeaders | (Optional) Auth specific headers to attach to a request object. Used to perform a request to Elasticsearch on behalf of an authenticated user. | -| [responseHeaders?](./kibana-plugin-core-server.authresultparams.responseheaders.md) | AuthHeaders | (Optional) Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. | -| [state?](./kibana-plugin-core-server.authresultparams.state.md) | Record<string, any> | (Optional) Data to associate with an incoming request. Any downstream plugin may get access to the data. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md deleted file mode 100644 index aa5b054a93e56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.requestheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [requestHeaders](./kibana-plugin-core-server.authresultparams.requestheaders.md) - -## AuthResultParams.requestHeaders property - -Auth specific headers to attach to a request object. Used to perform a request to Elasticsearch on behalf of an authenticated user. - -Signature: - -```typescript -requestHeaders?: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md deleted file mode 100644 index 5a203c83f6394..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.responseheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [responseHeaders](./kibana-plugin-core-server.authresultparams.responseheaders.md) - -## AuthResultParams.responseHeaders property - -Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. - -Signature: - -```typescript -responseHeaders?: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md b/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md deleted file mode 100644 index 8d35f1676b318..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresultparams.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) > [state](./kibana-plugin-core-server.authresultparams.state.md) - -## AuthResultParams.state property - -Data to associate with an incoming request. Any downstream plugin may get access to the data. - -Signature: - -```typescript -state?: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authresulttype.md b/docs/development/core/server/kibana-plugin-core-server.authresulttype.md deleted file mode 100644 index 5e68edd9aa66b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authresulttype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthResultType](./kibana-plugin-core-server.authresulttype.md) - -## AuthResultType enum - - -Signature: - -```typescript -export declare enum AuthResultType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| authenticated | "authenticated" | | -| notHandled | "notHandled" | | -| redirected | "redirected" | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authstatus.md b/docs/development/core/server/kibana-plugin-core-server.authstatus.md deleted file mode 100644 index d022392c6f188..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authstatus.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthStatus](./kibana-plugin-core-server.authstatus.md) - -## AuthStatus enum - -Status indicating an outcome of the authentication. - -Signature: - -```typescript -export declare enum AuthStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| authenticated | "authenticated" | auth interceptor successfully authenticated a user | -| unauthenticated | "unauthenticated" | auth interceptor failed user authentication | -| unknown | "unknown" | auth interceptor has not been registered | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md deleted file mode 100644 index 7cfb4efd29662..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.authenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [authenticated](./kibana-plugin-core-server.authtoolkit.authenticated.md) - -## AuthToolkit.authenticated property - -Authentication is successful with given credentials, allow request to pass through - -Signature: - -```typescript -authenticated: (data?: AuthResultParams) => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md deleted file mode 100644 index 24b561d04bbb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) - -## AuthToolkit interface - -A tool set defining an outcome of Auth interceptor for incoming request. - -Signature: - -```typescript -export interface AuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authenticated](./kibana-plugin-core-server.authtoolkit.authenticated.md) | (data?: AuthResultParams) => AuthResult | Authentication is successful with given credentials, allow request to pass through | -| [notHandled](./kibana-plugin-core-server.authtoolkit.nothandled.md) | () => AuthResult | User has no credentials. Allows user to access a resource when authRequired is 'optional' Rejects a request when authRequired: true | -| [redirected](./kibana-plugin-core-server.authtoolkit.redirected.md) | (headers: { location: string; } & ResponseHeaders) => AuthResult | Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' | - diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md deleted file mode 100644 index 577faa6562558..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.nothandled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [notHandled](./kibana-plugin-core-server.authtoolkit.nothandled.md) - -## AuthToolkit.notHandled property - -User has no credentials. Allows user to access a resource when authRequired is 'optional' Rejects a request when authRequired: true - -Signature: - -```typescript -notHandled: () => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md b/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md deleted file mode 100644 index 92d2181f24765..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.authtoolkit.redirected.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) > [redirected](./kibana-plugin-core-server.authtoolkit.redirected.md) - -## AuthToolkit.redirected property - -Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' - -Signature: - -```typescript -redirected: (headers: { - location: string; - } & ResponseHeaders) => AuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md deleted file mode 100644 index 273945166735b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [correctiveActions](./kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md) - -## BaseDeprecationDetails.correctiveActions property - -corrective action needed to fix this deprecation. - -Signature: - -```typescript -correctiveActions: { - api?: { - path: string; - method: 'POST' | 'PUT'; - body?: { - [key: string]: any; - }; - omitContextFromBody?: boolean; - }; - manualSteps: string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md deleted file mode 100644 index 072dfd17418f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md) - -## BaseDeprecationDetails.deprecationType property - -(optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab. - -Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations. - -Signature: - -```typescript -deprecationType?: 'config' | 'feature'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md deleted file mode 100644 index c8f0762acdce6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.documentationurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [documentationUrl](./kibana-plugin-core-server.basedeprecationdetails.documentationurl.md) - -## BaseDeprecationDetails.documentationUrl property - -(optional) link to the documentation for more details on the deprecation. - -Signature: - -```typescript -documentationUrl?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md deleted file mode 100644 index ad755805d00b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [level](./kibana-plugin-core-server.basedeprecationdetails.level.md) - -## BaseDeprecationDetails.level property - -levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. - -Signature: - -```typescript -level: 'warning' | 'critical' | 'fetch_error'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md deleted file mode 100644 index bcd96e35295ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) - -## BaseDeprecationDetails interface - -Base properties shared by all types of deprecations - -Signature: - -```typescript -export interface BaseDeprecationDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [correctiveActions](./kibana-plugin-core-server.basedeprecationdetails.correctiveactions.md) | { api?: { path: string; method: 'POST' \| 'PUT'; body?: { \[key: string\]: any; }; omitContextFromBody?: boolean; }; manualSteps: string\[\]; } | corrective action needed to fix this deprecation. | -| [deprecationType?](./kibana-plugin-core-server.basedeprecationdetails.deprecationtype.md) | 'config' \| 'feature' | (Optional) (optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab.Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations. | -| [documentationUrl?](./kibana-plugin-core-server.basedeprecationdetails.documentationurl.md) | string | (Optional) (optional) link to the documentation for more details on the deprecation. | -| [level](./kibana-plugin-core-server.basedeprecationdetails.level.md) | 'warning' \| 'critical' \| 'fetch\_error' | levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. | -| [message](./kibana-plugin-core-server.basedeprecationdetails.message.md) | string | The description message to be displayed for the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx | -| [requireRestart?](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) | boolean | (Optional) (optional) specify the fix for this deprecation requires a full kibana restart. | -| [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) | string | The title of the deprecation. Check the README for writing deprecations in src/core/server/deprecations/README.mdx | - diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md deleted file mode 100644 index 5802bc316cc08..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [message](./kibana-plugin-core-server.basedeprecationdetails.message.md) - -## BaseDeprecationDetails.message property - -The description message to be displayed for the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx` - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md deleted file mode 100644 index 3f589600d0458..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.requirerestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [requireRestart](./kibana-plugin-core-server.basedeprecationdetails.requirerestart.md) - -## BaseDeprecationDetails.requireRestart property - -(optional) specify the fix for this deprecation requires a full kibana restart. - -Signature: - -```typescript -requireRestart?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md b/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md deleted file mode 100644 index b6788a4faa7c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basedeprecationdetails.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) > [title](./kibana-plugin-core-server.basedeprecationdetails.title.md) - -## BaseDeprecationDetails.title property - -The title of the deprecation. Check the README for writing deprecations in `src/core/server/deprecations/README.mdx` - -Signature: - -```typescript -title: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md b/docs/development/core/server/kibana-plugin-core-server.basepath.get.md deleted file mode 100644 index b35c6e657b01f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [get](./kibana-plugin-core-server.basepath.get.md) - -## BasePath.get property - -returns `basePath` value, specific for an incoming request. - -Signature: - -```typescript -get: (request: KibanaRequest) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.md deleted file mode 100644 index 4fae861cf1659..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) - -## BasePath class - -Access or manipulate the Kibana base path - -Signature: - -```typescript -export declare class BasePath -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [get](./kibana-plugin-core-server.basepath.get.md) | | (request: KibanaRequest) => string | returns basePath value, specific for an incoming request. | -| [prepend](./kibana-plugin-core-server.basepath.prepend.md) | | (path: string) => string | Prepends path with the basePath. | -| [publicBaseUrl?](./kibana-plugin-core-server.basepath.publicbaseurl.md) | | string | (Optional) The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). | -| [remove](./kibana-plugin-core-server.basepath.remove.md) | | (path: string) => string | Removes the prepended basePath from the path. | -| [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) | | string | returns the server's basePathSee [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request | -| [set](./kibana-plugin-core-server.basepath.set.md) | | (request: KibanaRequest, requestSpecificBasePath: string) => void | sets basePath value, specific for an incoming request. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md b/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md deleted file mode 100644 index 94ddf74372cc4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.prepend.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [prepend](./kibana-plugin-core-server.basepath.prepend.md) - -## BasePath.prepend property - -Prepends `path` with the basePath. - -Signature: - -```typescript -prepend: (path: string) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md b/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md deleted file mode 100644 index 65842333ac246..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md) - -## BasePath.publicBaseUrl property - -The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md). - -Signature: - -```typescript -readonly publicBaseUrl?: string; -``` - -## Remarks - -Should be used for generating external URL links back to this Kibana instance. - diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md b/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md deleted file mode 100644 index 13ccd9db6ab86..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [remove](./kibana-plugin-core-server.basepath.remove.md) - -## BasePath.remove property - -Removes the prepended basePath from the `path`. - -Signature: - -```typescript -remove: (path: string) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md b/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md deleted file mode 100644 index 01fc9b69055f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.serverbasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) - -## BasePath.serverBasePath property - -returns the server's basePath - -See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request - -Signature: - -```typescript -readonly serverBasePath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md b/docs/development/core/server/kibana-plugin-core-server.basepath.set.md deleted file mode 100644 index b90767022d594..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.basepath.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [BasePath](./kibana-plugin-core-server.basepath.md) > [set](./kibana-plugin-core-server.basepath.set.md) - -## BasePath.set property - -sets `basePath` value, specific for an incoming request. - -Signature: - -```typescript -set: (request: KibanaRequest, requestSpecificBasePath: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md deleted file mode 100644 index 7b93d3b885d23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.catalogue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [catalogue](./kibana-plugin-core-server.capabilities.catalogue.md) - -## Capabilities.catalogue property - -Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. - -Signature: - -```typescript -catalogue: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md deleted file mode 100644 index 968faadf43774..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.management.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [management](./kibana-plugin-core-server.capabilities.management.md) - -## Capabilities.management property - -Management section capabilities. - -Signature: - -```typescript -management: { - [sectionId: string]: Record; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.md deleted file mode 100644 index a5900e96a86b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) - -## Capabilities interface - -The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. - -Signature: - -```typescript -export interface Capabilities -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [catalogue](./kibana-plugin-core-server.capabilities.catalogue.md) | Record<string, boolean> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. | -| [management](./kibana-plugin-core-server.capabilities.management.md) | { \[sectionId: string\]: Record<string, boolean>; } | Management section capabilities. | -| [navLinks](./kibana-plugin-core-server.capabilities.navlinks.md) | Record<string, boolean> | Navigation link capabilities. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md b/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md deleted file mode 100644 index 0e68239ff4eee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilities.navlinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Capabilities](./kibana-plugin-core-server.capabilities.md) > [navLinks](./kibana-plugin-core-server.capabilities.navlinks.md) - -## Capabilities.navLinks property - -Navigation link capabilities. - -Signature: - -```typescript -navLinks: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md deleted file mode 100644 index 2f71e4b9bb18a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) - -## CapabilitiesProvider type - -See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -export declare type CapabilitiesProvider = () => Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md deleted file mode 100644 index 19e7f05b20415..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -## CapabilitiesSetup interface - -APIs to manage the [Capabilities](./kibana-plugin-core-server.capabilities.md) that will be used by the application. - -Plugins relying on capabilities to toggle some of their features should register them during the setup phase using the `registerProvider` method. - -Plugins having the responsibility to restrict capabilities depending on a given context should register their capabilities switcher using the `registerSwitcher` method. - -Refers to the methods documentation for complete description and examples. - -Signature: - -```typescript -export interface CapabilitiesSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [registerProvider(provider)](./kibana-plugin-core-server.capabilitiessetup.registerprovider.md) | Register a [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) to be used to provide [Capabilities](./kibana-plugin-core-server.capabilities.md) when resolving them. | -| [registerSwitcher(switcher)](./kibana-plugin-core-server.capabilitiessetup.registerswitcher.md) | Register a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) to be used to change the default state of the [Capabilities](./kibana-plugin-core-server.capabilities.md) entries when resolving them.A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md deleted file mode 100644 index 9122f7e0f11ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerprovider.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) > [registerProvider](./kibana-plugin-core-server.capabilitiessetup.registerprovider.md) - -## CapabilitiesSetup.registerProvider() method - -Register a [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) to be used to provide [Capabilities](./kibana-plugin-core-server.capabilities.md) when resolving them. - -Signature: - -```typescript -registerProvider(provider: CapabilitiesProvider): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| provider | CapabilitiesProvider | | - -Returns: - -void - -## Example - -How to register a plugin's capabilities during setup - -```ts -// my-plugin/server/plugin.ts -public setup(core: CoreSetup, deps: {}) { - core.capabilities.registerProvider(() => { - return { - catalogue: { - myPlugin: true, - }, - myPlugin: { - someFeature: true, - featureDisabledByDefault: false, - }, - } - }); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md deleted file mode 100644 index c07703c1f365f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiessetup.registerswitcher.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) > [registerSwitcher](./kibana-plugin-core-server.capabilitiessetup.registerswitcher.md) - -## CapabilitiesSetup.registerSwitcher() method - -Register a [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) to be used to change the default state of the [Capabilities](./kibana-plugin-core-server.capabilities.md) entries when resolving them. - -A capabilities switcher can only change the state of existing capabilities. Capabilities added or removed when invoking the switcher will be ignored. - -Signature: - -```typescript -registerSwitcher(switcher: CapabilitiesSwitcher): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| switcher | CapabilitiesSwitcher | | - -Returns: - -void - -## Example - -How to restrict some capabilities - -```ts -// my-plugin/server/plugin.ts -public setup(core: CoreSetup, deps: {}) { - core.capabilities.registerSwitcher((request, capabilities, useDefaultCapabilities) => { - // useDefaultCapabilities is a special case that switchers typically don't have to concern themselves with. - // The default capabilities are typically the ones you provide in your CapabilitiesProvider, but this flag - // gives each switcher an opportunity to change the default capabilities of other plugins' capabilities. - // For example, you may decide to flip another plugin's capability to false if today is Tuesday, - // but you wouldn't want to do this when we are requesting the default set of capabilities. - if (useDefaultCapabilities) { - return { - somePlugin: { - featureEnabledByDefault: true - } - } - } - if(myPluginApi.shouldRestrictSomePluginBecauseOf(request)) { - return { - somePlugin: { - featureEnabledByDefault: false // `featureEnabledByDefault` will be disabled. All other capabilities will remain unchanged. - } - } - } - return {}; // All capabilities will remain unchanged. - }); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md deleted file mode 100644 index 217a782be9d8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) - -## CapabilitiesStart interface - -APIs to access the application [Capabilities](./kibana-plugin-core-server.capabilities.md). - -Signature: - -```typescript -export interface CapabilitiesStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [resolveCapabilities(request, options)](./kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md) | Resolve the [Capabilities](./kibana-plugin-core-server.capabilities.md) to be used for given request | - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md deleted file mode 100644 index a9dc279526065..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) > [resolveCapabilities](./kibana-plugin-core-server.capabilitiesstart.resolvecapabilities.md) - -## CapabilitiesStart.resolveCapabilities() method - -Resolve the [Capabilities](./kibana-plugin-core-server.capabilities.md) to be used for given request - -Signature: - -```typescript -resolveCapabilities(request: KibanaRequest, options?: ResolveCapabilitiesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | KibanaRequest | | -| options | ResolveCapabilitiesOptions | | - -Returns: - -Promise<Capabilities> - diff --git a/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md b/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md deleted file mode 100644 index e6a0a9a096671..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.capabilitiesswitcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) - -## CapabilitiesSwitcher type - -See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -export declare type CapabilitiesSwitcher = (request: KibanaRequest, uiCapabilities: Capabilities, useDefaultCapabilities: boolean) => Partial | Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md deleted file mode 100644 index 7af6c16d86e4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.configpath.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) > [configPath](./kibana-plugin-core-server.configdeprecationdetails.configpath.md) - -## ConfigDeprecationDetails.configPath property - -Signature: - -```typescript -configPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md deleted file mode 100644 index fb3737062f986..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md) - -## ConfigDeprecationDetails.deprecationType property - -Signature: - -```typescript -deprecationType: 'config'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md deleted file mode 100644 index 6065d1fc1889f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.configdeprecationdetails.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) - -## ConfigDeprecationDetails interface - - -Signature: - -```typescript -export interface ConfigDeprecationDetails extends BaseDeprecationDetails -``` -Extends: BaseDeprecationDetails - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [configPath](./kibana-plugin-core-server.configdeprecationdetails.configpath.md) | string | | -| [deprecationType](./kibana-plugin-core-server.configdeprecationdetails.deprecationtype.md) | 'config' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md deleted file mode 100644 index 5e60dd7e2ffd7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.contextsetup.createcontextcontainer.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ContextSetup](./kibana-plugin-core-server.contextsetup.md) > [createContextContainer](./kibana-plugin-core-server.contextsetup.createcontextcontainer.md) - -## ContextSetup.createContextContainer() method - -Creates a new [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for a service owner. - -Signature: - -```typescript -createContextContainer(): IContextContainer; -``` -Returns: - -IContextContainer - diff --git a/docs/development/core/server/kibana-plugin-core-server.contextsetup.md b/docs/development/core/server/kibana-plugin-core-server.contextsetup.md deleted file mode 100644 index a15adccc97714..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.contextsetup.md +++ /dev/null @@ -1,136 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ContextSetup](./kibana-plugin-core-server.contextsetup.md) - -## ContextSetup interface - -An object that handles registration of context providers and configuring handlers with context. - -Signature: - -```typescript -export interface ContextSetup -``` - -## Remarks - -A [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares. - -Contexts providers are executed in the order they were registered. Each provider gets access to context values provided by any plugins that it depends on. - -In order to configure a handler with context, you must call the [IContextContainer.createHandler()](./kibana-plugin-core-server.icontextcontainer.createhandler.md) function and use the returned handler which will automatically build a context object when called. - -When registering context or creating handlers, the \_calling plugin's opaque id\_ must be provided. This id is passed in via the plugin's initializer and can be accessed from the [PluginInitializerContext.opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) Note this should NOT be the context service owner's id, but the plugin that is actually registering the context or handler. - -```ts -// Correct -class MyPlugin { - private readonly handlers = new Map(); - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(pluginOpaqueId, contextName, provider) { - this.contextContainer.registerContext(pluginOpaqueId, contextName, provider); - }, - registerRoute(pluginOpaqueId, path, handler) { - this.handlers.set( - path, - this.contextContainer.createHandler(pluginOpaqueId, handler) - ); - } - } - } -} - -// Incorrect -class MyPlugin { - private readonly handlers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(contextName, provider) { - // BUG! - // This would leak this context to all handlers rather that only plugins that depend on the calling plugin. - this.contextContainer.registerContext(this.initContext.opaqueId, contextName, provider); - }, - registerRoute(path, handler) { - this.handlers.set( - path, - // BUG! - // This handler will not receive any contexts provided by other dependencies of the calling plugin. - this.contextContainer.createHandler(this.initContext.opaqueId, handler) - ); - } - } - } -} -``` - -## Example - -Say we're creating a plugin for rendering visualizations that allows new rendering methods to be registered. If we want to offer context to these rendering methods, we can leverage the ContextService to manage these contexts. - -```ts -export interface VizRenderContext { - core: { - i18n: I18nStart; - uiSettings: IUiSettingsClient; - } - [contextName: string]: unknown; -} - -export type VizRenderer = (context: VizRenderContext, domElement: HTMLElement) => () => void; -// When a renderer is bound via `contextContainer.createHandler` this is the type that will be returned. -type BoundVizRenderer = (domElement: HTMLElement) => () => void; - -class VizRenderingPlugin { - private readonly contextContainer?: IContextContainer; - private readonly vizRenderers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - - return { - registerContext: this.contextContainer.registerContext, - registerVizRenderer: (plugin: PluginOpaqueId, renderMethod: string, renderer: VizTypeRenderer) => - this.vizRenderers.set(renderMethod, this.contextContainer.createHandler(plugin, renderer)), - }; - } - - start(core) { - // Register the core context available to all renderers. Use the VizRendererContext's opaqueId as the first arg. - this.contextContainer.registerContext(this.initContext.opaqueId, 'core', () => ({ - i18n: core.i18n, - uiSettings: core.uiSettings - })); - - return { - registerContext: this.contextContainer.registerContext, - - renderVizualization: (renderMethod: string, domElement: HTMLElement) => { - if (!this.vizRenderer.has(renderMethod)) { - throw new Error(`Render method '${renderMethod}' has not been registered`); - } - - // The handler can now be called directly with only an `HTMLElement` and will automatically - // have a new `context` object created and populated by the context container. - const handler = this.vizRenderers.get(renderMethod) - return handler(domElement); - } - }; - } -} -``` - -## Methods - -| Method | Description | -| --- | --- | -| [createContextContainer()](./kibana-plugin-core-server.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for a service owner. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md deleted file mode 100644 index b9846fa851b35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [analytics](./kibana-plugin-core-server.corepreboot.analytics.md) - -## CorePreboot.analytics property - -[AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) - -Signature: - -```typescript -analytics: AnalyticsServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md deleted file mode 100644 index 7d3b5296b5988..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) - -## CorePreboot.elasticsearch property - -[ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md deleted file mode 100644 index 0df643c6f133b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [http](./kibana-plugin-core-server.corepreboot.http.md) - -## CorePreboot.http property - -[HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) - -Signature: - -```typescript -http: HttpServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.md deleted file mode 100644 index 027dca5362f8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) - -## CorePreboot interface - -Context passed to the `setup` method of `preboot` plugins. - -Signature: - -```typescript -export interface CorePreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.corepreboot.analytics.md) | AnalyticsServicePreboot | [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) | -| [elasticsearch](./kibana-plugin-core-server.corepreboot.elasticsearch.md) | ElasticsearchServicePreboot | [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | -| [http](./kibana-plugin-core-server.corepreboot.http.md) | HttpServicePreboot | [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) | -| [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) | PrebootServicePreboot | [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md b/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md deleted file mode 100644 index 3780a92053a5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corepreboot.preboot.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CorePreboot](./kibana-plugin-core-server.corepreboot.md) > [preboot](./kibana-plugin-core-server.corepreboot.preboot.md) - -## CorePreboot.preboot property - -[PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) - -Signature: - -```typescript -preboot: PrebootServicePreboot; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md deleted file mode 100644 index 51d93371e518e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md) - -## CoreRequestHandlerContext.deprecations property - -Signature: - -```typescript -deprecations: { - client: DeprecationsClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md deleted file mode 100644 index 22ff84ce1cb57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md) - -## CoreRequestHandlerContext.elasticsearch property - -Signature: - -```typescript -elasticsearch: { - client: IScopedClusterClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md deleted file mode 100644 index 47297bcddc906..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) - -## CoreRequestHandlerContext interface - -The `core` context provided to route handler. - -Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request - -Signature: - -```typescript -export interface CoreRequestHandlerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md) | { client: DeprecationsClient; } | | -| [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md) | { client: IScopedClusterClient; } | | -| [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md) | { client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; } | | -| [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md) | { client: IUiSettingsClient; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md deleted file mode 100644 index 6d1aa0a8bb5f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md) - -## CoreRequestHandlerContext.savedObjects property - -Signature: - -```typescript -savedObjects: { - client: SavedObjectsClientContract; - typeRegistry: ISavedObjectTypeRegistry; - getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; - getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; - getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md deleted file mode 100644 index f76dcc8965a03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) > [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md) - -## CoreRequestHandlerContext.uiSettings property - -Signature: - -```typescript -uiSettings: { - client: IUiSettingsClient; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md deleted file mode 100644 index 3e6d8a5c2c230..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [analytics](./kibana-plugin-core-server.coresetup.analytics.md) - -## CoreSetup.analytics property - -[AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) - -Signature: - -```typescript -analytics: AnalyticsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md deleted file mode 100644 index 29e66998ab825..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [capabilities](./kibana-plugin-core-server.coresetup.capabilities.md) - -## CoreSetup.capabilities property - -[CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) - -Signature: - -```typescript -capabilities: CapabilitiesSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md deleted file mode 100644 index fd8a71f3ff93c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.context.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [context](./kibana-plugin-core-server.coresetup.context.md) - -## CoreSetup.context property - -[ContextSetup](./kibana-plugin-core-server.contextsetup.md) - -Signature: - -```typescript -context: ContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md deleted file mode 100644 index 436cc29b6e343..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md) - -## CoreSetup.deprecations property - -[DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) - -Signature: - -```typescript -deprecations: DeprecationsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md deleted file mode 100644 index 68dcc7c9af53f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [docLinks](./kibana-plugin-core-server.coresetup.doclinks.md) - -## CoreSetup.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md deleted file mode 100644 index ed1a87034f51d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) - -## CoreSetup.elasticsearch property - -[ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md deleted file mode 100644 index 847b353aee44f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [executionContext](./kibana-plugin-core-server.coresetup.executioncontext.md) - -## CoreSetup.executionContext property - -[ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) - -Signature: - -```typescript -executionContext: ExecutionContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md deleted file mode 100644 index 1f326449156f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.getstartservices.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) - -## CoreSetup.getStartServices property - -[StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) - -Signature: - -```typescript -getStartServices: StartServicesAccessor; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md deleted file mode 100644 index a8028827cc0a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.http.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [http](./kibana-plugin-core-server.coresetup.http.md) - -## CoreSetup.http property - -[HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) - -Signature: - -```typescript -http: HttpServiceSetup & { - resources: HttpResources; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md deleted file mode 100644 index cac878c1e4449..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.i18n.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [i18n](./kibana-plugin-core-server.coresetup.i18n.md) - -## CoreSetup.i18n property - -[I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) - -Signature: - -```typescript -i18n: I18nServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md deleted file mode 100644 index 78fcc9be2c677..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.logging.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [logging](./kibana-plugin-core-server.coresetup.logging.md) - -## CoreSetup.logging property - - -Signature: - -```typescript -logging: LoggingServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.md deleted file mode 100644 index cb8d26dc4dda4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) - -## CoreSetup interface - -Context passed to the `setup` method of `standard` plugins. - -Signature: - -```typescript -export interface CoreSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.coresetup.analytics.md) | AnalyticsServiceSetup | [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) | -| [capabilities](./kibana-plugin-core-server.coresetup.capabilities.md) | CapabilitiesSetup | [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [context](./kibana-plugin-core-server.coresetup.context.md) | ContextSetup | [ContextSetup](./kibana-plugin-core-server.contextsetup.md) | -| [deprecations](./kibana-plugin-core-server.coresetup.deprecations.md) | DeprecationsServiceSetup | [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) | -| [docLinks](./kibana-plugin-core-server.coresetup.doclinks.md) | DocLinksServiceSetup | | -| [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) | ElasticsearchServiceSetup | [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) | -| [executionContext](./kibana-plugin-core-server.coresetup.executioncontext.md) | ExecutionContextSetup | [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) | -| [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | StartServicesAccessor<TPluginsStart, TStart> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) | -| [http](./kibana-plugin-core-server.coresetup.http.md) | HttpServiceSetup & { resources: HttpResources; } | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | -| [i18n](./kibana-plugin-core-server.coresetup.i18n.md) | I18nServiceSetup | [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) | -| [logging](./kibana-plugin-core-server.coresetup.logging.md) | LoggingServiceSetup | | -| [metrics](./kibana-plugin-core-server.coresetup.metrics.md) | MetricsServiceSetup | [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | -| [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | SavedObjectsServiceSetup | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) | -| [status](./kibana-plugin-core-server.coresetup.status.md) | StatusServiceSetup | [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) | -| [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) | UiSettingsServiceSetup | [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md deleted file mode 100644 index 77c9e867ef8ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [metrics](./kibana-plugin-core-server.coresetup.metrics.md) - -## CoreSetup.metrics property - -[MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) - -Signature: - -```typescript -metrics: MetricsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md deleted file mode 100644 index 4b448b89bd3cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) - -## CoreSetup.savedObjects property - -[SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) - -Signature: - -```typescript -savedObjects: SavedObjectsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md deleted file mode 100644 index f5ea627a9f008..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.status.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [status](./kibana-plugin-core-server.coresetup.status.md) - -## CoreSetup.status property - -[StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) - -Signature: - -```typescript -status: StatusServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md deleted file mode 100644 index 60aff70155a72..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.coresetup.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreSetup](./kibana-plugin-core-server.coresetup.md) > [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) - -## CoreSetup.uiSettings property - -[UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) - -Signature: - -```typescript -uiSettings: UiSettingsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md b/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md deleted file mode 100644 index 7ea48c183f30e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.analytics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [analytics](./kibana-plugin-core-server.corestart.analytics.md) - -## CoreStart.analytics property - -[AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) - -Signature: - -```typescript -analytics: AnalyticsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md b/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md deleted file mode 100644 index 20705b7554c3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [capabilities](./kibana-plugin-core-server.corestart.capabilities.md) - -## CoreStart.capabilities property - -[CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) - -Signature: - -```typescript -capabilities: CapabilitiesStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md b/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md deleted file mode 100644 index e647d291d9172..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.doclinks.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [docLinks](./kibana-plugin-core-server.corestart.doclinks.md) - -## CoreStart.docLinks property - - -Signature: - -```typescript -docLinks: DocLinksServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md deleted file mode 100644 index d8f518ceebd64..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.elasticsearch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) - -## CoreStart.elasticsearch property - -[ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) - -Signature: - -```typescript -elasticsearch: ElasticsearchServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md b/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md deleted file mode 100644 index e58f4dc4afa32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.executioncontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [executionContext](./kibana-plugin-core-server.corestart.executioncontext.md) - -## CoreStart.executionContext property - -[ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) - -Signature: - -```typescript -executionContext: ExecutionContextStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.http.md b/docs/development/core/server/kibana-plugin-core-server.corestart.http.md deleted file mode 100644 index d81049dfbd340..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.http.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [http](./kibana-plugin-core-server.corestart.http.md) - -## CoreStart.http property - -[HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) - -Signature: - -```typescript -http: HttpServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.md b/docs/development/core/server/kibana-plugin-core-server.corestart.md deleted file mode 100644 index f5566e6671ef1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) - -## CoreStart interface - -Context passed to the plugins `start` method. - -Signature: - -```typescript -export interface CoreStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [analytics](./kibana-plugin-core-server.corestart.analytics.md) | AnalyticsServiceStart | [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) | -| [capabilities](./kibana-plugin-core-server.corestart.capabilities.md) | CapabilitiesStart | [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) | -| [docLinks](./kibana-plugin-core-server.corestart.doclinks.md) | DocLinksServiceStart | | -| [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) | ElasticsearchServiceStart | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | -| [executionContext](./kibana-plugin-core-server.corestart.executioncontext.md) | ExecutionContextStart | [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) | -| [http](./kibana-plugin-core-server.corestart.http.md) | HttpServiceStart | [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) | -| [metrics](./kibana-plugin-core-server.corestart.metrics.md) | MetricsServiceStart | [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) | -| [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) | SavedObjectsServiceStart | [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) | -| [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) | UiSettingsServiceStart | [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md b/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md deleted file mode 100644 index 2c32f730c4c9b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [metrics](./kibana-plugin-core-server.corestart.metrics.md) - -## CoreStart.metrics property - -[MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) - -Signature: - -```typescript -metrics: MetricsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md deleted file mode 100644 index cc31c256df88e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.savedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) - -## CoreStart.savedObjects property - -[SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) - -Signature: - -```typescript -savedObjects: SavedObjectsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md b/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md deleted file mode 100644 index 95c298820f3c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.uisettings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) - -## CoreStart.uiSettings property - -[UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) - -Signature: - -```typescript -uiSettings: UiSettingsServiceStart; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md deleted file mode 100644 index b41e7020c38e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.elasticsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) > [elasticsearch](./kibana-plugin-core-server.corestatus.elasticsearch.md) - -## CoreStatus.elasticsearch property - -Signature: - -```typescript -elasticsearch: ServiceStatus; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.md deleted file mode 100644 index 8d44ab49dfcb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) - -## CoreStatus interface - -Status of core services. - -Signature: - -```typescript -export interface CoreStatus -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elasticsearch](./kibana-plugin-core-server.corestatus.elasticsearch.md) | ServiceStatus | | -| [savedObjects](./kibana-plugin-core-server.corestatus.savedobjects.md) | ServiceStatus | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md b/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md deleted file mode 100644 index d554c6f70d720..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.corestatus.savedobjects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStatus](./kibana-plugin-core-server.corestatus.md) > [savedObjects](./kibana-plugin-core-server.corestatus.savedobjects.md) - -## CoreStatus.savedObjects property - -Signature: - -```typescript -savedObjects: ServiceStatus; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md deleted file mode 100644 index 0f31a554e2208..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) > [\_shards](./kibana-plugin-core-server.countresponse._shards.md) - -## CountResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md b/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md deleted file mode 100644 index 3cd1a6aaf6644..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse.count.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) > [count](./kibana-plugin-core-server.countresponse.count.md) - -## CountResponse.count property - -Signature: - -```typescript -count: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.countresponse.md b/docs/development/core/server/kibana-plugin-core-server.countresponse.md deleted file mode 100644 index 53793dc87bf33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.countresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CountResponse](./kibana-plugin-core-server.countresponse.md) - -## CountResponse interface - - -Signature: - -```typescript -export interface CountResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_shards](./kibana-plugin-core-server.countresponse._shards.md) | ShardsInfo | | -| [count](./kibana-plugin-core-server.countresponse.count.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md deleted file mode 100644 index 7668cf56dab83..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.default.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) - -## CspConfig.DEFAULT property - -Signature: - -```typescript -static readonly DEFAULT: CspConfig; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md deleted file mode 100644 index bbd7c42c302d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.disableembedding.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) - -## CspConfig.disableEmbedding property - -Signature: - -```typescript -readonly disableEmbedding: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md deleted file mode 100644 index ebde18e7b3586..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.header.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [header](./kibana-plugin-core-server.cspconfig.header.md) - -## CspConfig.header property - -Signature: - -```typescript -readonly header: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.md deleted file mode 100644 index 3d2f4bb683742..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) - -## CspConfig class - -CSP configuration for use in Kibana. - -Signature: - -```typescript -export declare class CspConfig implements ICspConfig -``` -Implements: ICspConfig - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CspConfig` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) | static | CspConfig | | -| [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) | | boolean | | -| [header](./kibana-plugin-core-server.cspconfig.header.md) | | string | | -| [strict](./kibana-plugin-core-server.cspconfig.strict.md) | | boolean | | -| [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) | | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md deleted file mode 100644 index 303d04373db73..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.strict.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [strict](./kibana-plugin-core-server.cspconfig.strict.md) - -## CspConfig.strict property - -Signature: - -```typescript -readonly strict: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md deleted file mode 100644 index 70c93c57864b7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) - -## CspConfig.warnLegacyBrowsers property - -Signature: - -```typescript -readonly warnLegacyBrowsers: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md deleted file mode 100644 index da37b33fe1bd0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [body](./kibana-plugin-core-server.customhttpresponseoptions.body.md) - -## CustomHttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md deleted file mode 100644 index bbd97ab517d29..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [bypassErrorFormat](./kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md) - -## CustomHttpResponseOptions.bypassErrorFormat property - -Bypass the default error formatting - -Signature: - -```typescript -bypassErrorFormat?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md deleted file mode 100644 index f317037482575..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [headers](./kibana-plugin-core-server.customhttpresponseoptions.headers.md) - -## CustomHttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md deleted file mode 100644 index 84cb55f5c1054..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) - -## CustomHttpResponseOptions interface - -HTTP response parameters for a response with adjustable status code. - -Signature: - -```typescript -export interface CustomHttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.customhttpresponseoptions.body.md) | T | (Optional) HTTP message to send to the client | -| [bypassErrorFormat?](./kibana-plugin-core-server.customhttpresponseoptions.bypasserrorformat.md) | boolean | (Optional) Bypass the default error formatting | -| [headers?](./kibana-plugin-core-server.customhttpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | -| [statusCode](./kibana-plugin-core-server.customhttpresponseoptions.statuscode.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md deleted file mode 100644 index 67cadcb5545a9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customhttpresponseoptions.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) > [statusCode](./kibana-plugin-core-server.customhttpresponseoptions.statuscode.md) - -## CustomHttpResponseOptions.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md deleted file mode 100644 index afaf8c278565a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.customrequesthandlercontext.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md) - -## CustomRequestHandlerContext type - - -Signature: - -```typescript -export declare type CustomRequestHandlerContext = RequestHandlerContext & { - [Key in keyof T]: T[Key] extends Promise ? T[Key] : Promise; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md deleted file mode 100644 index ccc6a76361f26..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md) - -## DeleteDocumentResponse.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md deleted file mode 100644 index a9a04bb2b2ed7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md) - -## DeleteDocumentResponse.\_index property - -Signature: - -```typescript -_index: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md deleted file mode 100644 index e3d5e9208db0a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md) - -## DeleteDocumentResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md deleted file mode 100644 index 690852e20a76e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md) - -## DeleteDocumentResponse.\_type property - -Signature: - -```typescript -_type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md deleted file mode 100644 index acfe8ef55ae71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md) - -## DeleteDocumentResponse.\_version property - -Signature: - -```typescript -_version: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md deleted file mode 100644 index aafe850188998..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [error](./kibana-plugin-core-server.deletedocumentresponse.error.md) - -## DeleteDocumentResponse.error property - -Signature: - -```typescript -error?: { - type: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md deleted file mode 100644 index 00bc89bda66ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [found](./kibana-plugin-core-server.deletedocumentresponse.found.md) - -## DeleteDocumentResponse.found property - -Signature: - -```typescript -found: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md deleted file mode 100644 index fe6712ea3b61c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) - -## DeleteDocumentResponse interface - - -Signature: - -```typescript -export interface DeleteDocumentResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md) | string | | -| [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md) | string | | -| [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md) | ShardsResponse | | -| [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md) | string | | -| [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md) | number | | -| [error?](./kibana-plugin-core-server.deletedocumentresponse.error.md) | { type: string; } | (Optional) | -| [found](./kibana-plugin-core-server.deletedocumentresponse.found.md) | boolean | | -| [result](./kibana-plugin-core-server.deletedocumentresponse.result.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md b/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md deleted file mode 100644 index 88f7568d3d9bc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) > [result](./kibana-plugin-core-server.deletedocumentresponse.result.md) - -## DeleteDocumentResponse.result property - -Signature: - -```typescript -result: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md deleted file mode 100644 index 90cd8daca24cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.getalldeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) > [getAllDeprecations](./kibana-plugin-core-server.deprecationsclient.getalldeprecations.md) - -## DeprecationsClient.getAllDeprecations property - -Signature: - -```typescript -getAllDeprecations: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md deleted file mode 100644 index 0e724e251b266..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsclient.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) - -## DeprecationsClient interface - -Server-side client that provides access to fetch all Kibana deprecations - -Signature: - -```typescript -export interface DeprecationsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getAllDeprecations](./kibana-plugin-core-server.deprecationsclient.getalldeprecations.md) | () => Promise<DomainDeprecationDetails\[\]> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md deleted file mode 100644 index d8ced1da62416..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsdetails.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) - -## DeprecationsDetails type - - -Signature: - -```typescript -export declare type DeprecationsDetails = ConfigDeprecationDetails | FeatureDeprecationDetails; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md deleted file mode 100644 index 9ad751f8082be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.doclinkskey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) > [docLinksKey](./kibana-plugin-core-server.deprecationsettings.doclinkskey.md) - -## DeprecationSettings.docLinksKey property - -Key to documentation links - -Signature: - -```typescript -docLinksKey: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md deleted file mode 100644 index 917ca933d63a1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) - -## DeprecationSettings interface - -UiSettings deprecation field options. - -Signature: - -```typescript -export interface DeprecationSettings -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [docLinksKey](./kibana-plugin-core-server.deprecationsettings.doclinkskey.md) | string | Key to documentation links | -| [message](./kibana-plugin-core-server.deprecationsettings.message.md) | string | Deprecation message | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md deleted file mode 100644 index 238600aff4e55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsettings.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) > [message](./kibana-plugin-core-server.deprecationsettings.message.md) - -## DeprecationSettings.message property - -Deprecation message - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md deleted file mode 100644 index 1fcefeea9b0ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md +++ /dev/null @@ -1,85 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) - -## DeprecationsServiceSetup interface - -The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version. - -The Deprecation service is consumed by the upgrade assistant to assist with the upgrade experience. - -If a deprecated feature can be resolved without manual user intervention. Using correctiveActions.api allows the Upgrade Assistant to use this api to correct the deprecation upon a user trigger. - -Signature: - -```typescript -export interface DeprecationsServiceSetup -``` - -## Example - - -```ts -import { DeprecationsDetails, GetDeprecationsContext, CoreSetup } from 'src/core/server'; -import { i18n } from '@kbn/i18n'; - -async function getDeprecations({ esClient, savedObjectsClient }: GetDeprecationsContext): Promise { - const deprecations: DeprecationsDetails[] = []; - const count = await getFooCount(savedObjectsClient); - if (count > 0) { - deprecations.push({ - title: i18n.translate('xpack.foo.deprecations.title', { - defaultMessage: `Foo's are deprecated` - }), - message: i18n.translate('xpack.foo.deprecations.message', { - defaultMessage: `You have {count} Foo's. Migrate your Foo's to a dashboard to continue using them.`, - values: { count }, - }), - documentationUrl: - 'https://www.elastic.co/guide/en/kibana/current/foo.html', - level: 'warning', - correctiveActions: { - manualSteps: [ - i18n.translate('xpack.foo.deprecations.manualStepOneMessage', { - defaultMessage: 'Navigate to the Kibana Dashboard and click "Create dashboard".', - }), - i18n.translate('xpack.foo.deprecations.manualStepTwoMessage', { - defaultMessage: 'Select Foo from the "New Visualization" window.', - }), - ], - api: { - path: '/internal/security/users/test_dashboard_user', - method: 'POST', - body: { - username: 'test_dashboard_user', - roles: [ - "machine_learning_user", - "enrich_user", - "kibana_admin" - ], - full_name: "Alison Goryachev", - email: "alisongoryachev@gmail.com", - metadata: {}, - enabled: true - } - }, - }, - }); - } - return deprecations; -} - - -export class Plugin() { - setup: (core: CoreSetup) => { - core.deprecations.registerDeprecations({ getDeprecations }); - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [registerDeprecations](./kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md) | (deprecationContext: RegisterDeprecationsConfig) => void | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md deleted file mode 100644 index 07c2a3ad0ce55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) > [registerDeprecations](./kibana-plugin-core-server.deprecationsservicesetup.registerdeprecations.md) - -## DeprecationsServiceSetup.registerDeprecations property - -Signature: - -```typescript -registerDeprecations: (deprecationContext: RegisterDeprecationsConfig) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md b/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md deleted file mode 100644 index 2c112ac7f6217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.destructiveroutemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) - -## DestructiveRouteMethod type - -Set of HTTP methods changing the state of the server. - -Signature: - -```typescript -export declare type DestructiveRouteMethod = 'post' | 'put' | 'delete' | 'patch'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md deleted file mode 100644 index 1dfb1ab7a0b42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md) - -## ElasticsearchClient type - -Client used to query the elasticsearch cluster. - -Signature: - -```typescript -export declare type ElasticsearchClient = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md deleted file mode 100644 index 2a8a99c17ad63..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchClientConfig](./kibana-plugin-core-server.elasticsearchclientconfig.md) - -## ElasticsearchClientConfig type - -Configuration options to be used to create a [cluster client](./kibana-plugin-core-server.iclusterclient.md) using the [createClient API](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) - -Signature: - -```typescript -export declare type ElasticsearchClientConfig = Pick & { - pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; - requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; - ssl?: Partial; - keepAlive?: boolean; - caFingerprint?: ClientOptions['caFingerprint']; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md deleted file mode 100644 index a8d9f1183b3e5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [(constructor)](./kibana-plugin-core-server.elasticsearchconfig._constructor_.md) - -## ElasticsearchConfig.(constructor) - -Constructs a new instance of the `ElasticsearchConfig` class - -Signature: - -```typescript -constructor(rawConfig: ElasticsearchConfigType); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| rawConfig | ElasticsearchConfigType | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md deleted file mode 100644 index 06ca6a2b9a691..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.apiversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [apiVersion](./kibana-plugin-core-server.elasticsearchconfig.apiversion.md) - -## ElasticsearchConfig.apiVersion property - -Version of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to. - -Signature: - -```typescript -readonly apiVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md deleted file mode 100644 index 5bc85dfb05647..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.compression.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [compression](./kibana-plugin-core-server.elasticsearchconfig.compression.md) - -## ElasticsearchConfig.compression property - -Whether to use compression for communications with elasticsearch. - -Signature: - -```typescript -readonly compression: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md deleted file mode 100644 index 93f94687956b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.customheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) - -## ElasticsearchConfig.customHeaders property - -Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by `requestHeadersWhitelist` configuration. - -Signature: - -```typescript -readonly customHeaders: ElasticsearchConfigType['customHeaders']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md deleted file mode 100644 index 904168a869d14..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) - -## ElasticsearchConfig.healthCheckDelay property - -The interval between health check requests Kibana sends to the Elasticsearch. - -Signature: - -```typescript -readonly healthCheckDelay: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md deleted file mode 100644 index f702512287c1c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.hosts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) - -## ElasticsearchConfig.hosts property - -Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. - -Signature: - -```typescript -readonly hosts: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md deleted file mode 100644 index 9d708f28a66c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) - -## ElasticsearchConfig.ignoreVersionMismatch property - -Whether to allow kibana to connect to a non-compatible elasticsearch node. - -Signature: - -```typescript -readonly ignoreVersionMismatch: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md deleted file mode 100644 index 64403f0cad543..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.maxsockets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [maxSockets](./kibana-plugin-core-server.elasticsearchconfig.maxsockets.md) - -## ElasticsearchConfig.maxSockets property - -The maximum number of sockets that can be used for communications with elasticsearch. - -Signature: - -```typescript -readonly maxSockets: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md deleted file mode 100644 index 593836664d5bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) - -## ElasticsearchConfig class - -Wrapper of config schema. - -Signature: - -```typescript -export declare class ElasticsearchConfig -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(rawConfig)](./kibana-plugin-core-server.elasticsearchconfig._constructor_.md) | | Constructs a new instance of the ElasticsearchConfig class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [apiVersion](./kibana-plugin-core-server.elasticsearchconfig.apiversion.md) | | string | Version of the Elasticsearch (6.7, 7.1 or master) client will be connecting to. | -| [compression](./kibana-plugin-core-server.elasticsearchconfig.compression.md) | | boolean | Whether to use compression for communications with elasticsearch. | -| [customHeaders](./kibana-plugin-core-server.elasticsearchconfig.customheaders.md) | | ElasticsearchConfigType\['customHeaders'\] | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by requestHeadersWhitelist configuration. | -| [healthCheckDelay](./kibana-plugin-core-server.elasticsearchconfig.healthcheckdelay.md) | | Duration | The interval between health check requests Kibana sends to the Elasticsearch. | -| [hosts](./kibana-plugin-core-server.elasticsearchconfig.hosts.md) | | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. | -| [ignoreVersionMismatch](./kibana-plugin-core-server.elasticsearchconfig.ignoreversionmismatch.md) | | boolean | Whether to allow kibana to connect to a non-compatible elasticsearch node. | -| [maxSockets](./kibana-plugin-core-server.elasticsearchconfig.maxsockets.md) | | number | The maximum number of sockets that can be used for communications with elasticsearch. | -| [password?](./kibana-plugin-core-server.elasticsearchconfig.password.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. | -| [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) | | Duration | Timeout after which PING HTTP request will be aborted and retried. | -| [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) | | string\[\] | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. | -| [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) | | Duration | Timeout after which HTTP request will be aborted and retried. | -| [serviceAccountToken?](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) | | string | (Optional) If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions.This is an alternative to specifying a username and password. | -| [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) | | Duration | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. | -| [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) | | false \| Duration | Interval to perform a sniff operation and make sure the list of nodes is complete. If false then sniffing is disabled. | -| [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) | | boolean | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. | -| [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) | | boolean | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. | -| [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) | | Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' \| 'keystore' \| 'truststore'>> & { certificateAuthorities?: string\[\]; } | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full. | -| [username?](./kibana-plugin-core-server.elasticsearchconfig.username.md) | | string | (Optional) If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md deleted file mode 100644 index 2f927b5bc7c76..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.password.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [password](./kibana-plugin-core-server.elasticsearchconfig.password.md) - -## ElasticsearchConfig.password property - -If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. - -Signature: - -```typescript -readonly password?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md deleted file mode 100644 index 07e37974219de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [pingTimeout](./kibana-plugin-core-server.elasticsearchconfig.pingtimeout.md) - -## ElasticsearchConfig.pingTimeout property - -Timeout after which PING HTTP request will be aborted and retried. - -Signature: - -```typescript -readonly pingTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md deleted file mode 100644 index c19dcd3896366..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [requestHeadersWhitelist](./kibana-plugin-core-server.elasticsearchconfig.requestheaderswhitelist.md) - -## ElasticsearchConfig.requestHeadersWhitelist property - -List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. - -Signature: - -```typescript -readonly requestHeadersWhitelist: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md deleted file mode 100644 index f43cfc754b1f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) - -## ElasticsearchConfig.requestTimeout property - -Timeout after which HTTP request will be aborted and retried. - -Signature: - -```typescript -readonly requestTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md deleted file mode 100644 index 5934e83de17a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [serviceAccountToken](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) - -## ElasticsearchConfig.serviceAccountToken property - -If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions. - -This is an alternative to specifying a username and password. - -Signature: - -```typescript -readonly serviceAccountToken?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md deleted file mode 100644 index c29f00a074e3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) - -## ElasticsearchConfig.shardTimeout property - -Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. - -Signature: - -```typescript -readonly shardTimeout: Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md deleted file mode 100644 index 19f6968b13863..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) - -## ElasticsearchConfig.sniffInterval property - -Interval to perform a sniff operation and make sure the list of nodes is complete. If `false` then sniffing is disabled. - -Signature: - -```typescript -readonly sniffInterval: false | Duration; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md deleted file mode 100644 index a632b446a55fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffOnConnectionFault](./kibana-plugin-core-server.elasticsearchconfig.sniffonconnectionfault.md) - -## ElasticsearchConfig.sniffOnConnectionFault property - -Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. - -Signature: - -```typescript -readonly sniffOnConnectionFault: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md deleted file mode 100644 index 09f3431c71880..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [sniffOnStart](./kibana-plugin-core-server.elasticsearchconfig.sniffonstart.md) - -## ElasticsearchConfig.sniffOnStart property - -Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. - -Signature: - -```typescript -readonly sniffOnStart: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md deleted file mode 100644 index f88fc57339475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.ssl.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [ssl](./kibana-plugin-core-server.elasticsearchconfig.ssl.md) - -## ElasticsearchConfig.ssl property - -Set of settings configure SSL connection between Kibana and Elasticsearch that are required when `xpack.ssl.verification_mode` in Elasticsearch is set to either `certificate` or `full`. - -Signature: - -```typescript -readonly ssl: Pick> & { - certificateAuthorities?: string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md deleted file mode 100644 index 959870ff43a0f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfig.username.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) > [username](./kibana-plugin-core-server.elasticsearchconfig.username.md) - -## ElasticsearchConfig.username property - -If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. Cannot be used in conjunction with serviceAccountToken. - -Signature: - -```typescript -readonly username?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md deleted file mode 100644 index df99d5ec4b831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) > [credentialsSpecified](./kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md) - -## ElasticsearchConfigPreboot.credentialsSpecified property - -Indicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`). - -Signature: - -```typescript -readonly credentialsSpecified: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md deleted file mode 100644 index e9ad47b61419e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) > [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) - -## ElasticsearchConfigPreboot.hosts property - -Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. - -Signature: - -```typescript -readonly hosts: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md deleted file mode 100644 index d7d3e8d70e8d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchconfigpreboot.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) - -## ElasticsearchConfigPreboot interface - -A limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`. - -Signature: - -```typescript -export interface ElasticsearchConfigPreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [credentialsSpecified](./kibana-plugin-core-server.elasticsearchconfigpreboot.credentialsspecified.md) | boolean | Indicates whether Elasticsearch configuration includes credentials (username, password or serviceAccountToken). | -| [hosts](./kibana-plugin-core-server.elasticsearchconfigpreboot.hosts.md) | string\[\] | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md deleted file mode 100644 index 7191caea54929..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.error.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) > [error](./kibana-plugin-core-server.elasticsearcherrordetails.error.md) - -## ElasticsearchErrorDetails.error property - -Signature: - -```typescript -error?: { - type: string; - reason?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md deleted file mode 100644 index 570a161db20e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearcherrordetails.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) - -## ElasticsearchErrorDetails interface - - -Signature: - -```typescript -export interface ElasticsearchErrorDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error?](./kibana-plugin-core-server.elasticsearcherrordetails.error.md) | { type: string; reason?: string; } | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md deleted file mode 100644 index c4284248ea894..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.config.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) - -## ElasticsearchServicePreboot.config property - -A limited set of Elasticsearch configuration entries. - -Signature: - -```typescript -readonly config: Readonly; -``` - -## Example - - -```js -const { hosts, credentialsSpecified } = core.elasticsearch.config; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md deleted file mode 100644 index 070cb7905b585..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) - -## ElasticsearchServicePreboot.createClient property - -Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). - -Signature: - -```typescript -readonly createClient: (type: string, clientConfig?: Partial) => ICustomClusterClient; -``` - -## Example - - -```js -const client = elasticsearch.createClient('my-app-name', config); -const data = await client.asInternalUser.search(); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md deleted file mode 100644 index 14dc099d13835..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicepreboot.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) - -## ElasticsearchServicePreboot interface - - -Signature: - -```typescript -export interface ElasticsearchServicePreboot -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-server.elasticsearchservicepreboot.config.md) | Readonly<ElasticsearchConfigPreboot> | A limited set of Elasticsearch configuration entries. | -| [createClient](./kibana-plugin-core-server.elasticsearchservicepreboot.createclient.md) | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md deleted file mode 100644 index 03e2be0da7a10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.legacy.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) > [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) - -## ElasticsearchServiceSetup.legacy property - -> Warning: This API is now obsolete. -> -> - -Signature: - -```typescript -legacy: { - readonly config$: Observable; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md deleted file mode 100644 index f66333427a224..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) - -## ElasticsearchServiceSetup interface - - -Signature: - -```typescript -export interface ElasticsearchServiceSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [legacy](./kibana-plugin-core-server.elasticsearchservicesetup.legacy.md) | { readonly config$: Observable<ElasticsearchConfig>; } | | -| [setUnauthorizedErrorHandler](./kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md) | (handler: UnauthorizedErrorHandler) => void | Register a handler that will be called when unauthorized (401) errors are returned from any API call to elasticsearch performed on behalf of a user via a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md deleted file mode 100644 index ee403a800d934..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) > [setUnauthorizedErrorHandler](./kibana-plugin-core-server.elasticsearchservicesetup.setunauthorizederrorhandler.md) - -## ElasticsearchServiceSetup.setUnauthorizedErrorHandler property - -Register a handler that will be called when unauthorized (401) errors are returned from any API call to elasticsearch performed on behalf of a user via a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md). - -Signature: - -```typescript -setUnauthorizedErrorHandler: (handler: UnauthorizedErrorHandler) => void; -``` - -## Remarks - -The handler will only be invoked for scoped client bound to real [request](./kibana-plugin-core-server.kibanarequest.md) instances. - -## Example - - -```ts -const handler: UnauthorizedErrorHandler = ({ request, error }, toolkit) => { - const reauthenticationResult = await authenticator.reauthenticate(request, error); - if (reauthenticationResult.succeeded()) { - return toolkit.retry({ - authHeaders: reauthenticationResult.authHeaders, - }); - } - return toolkit.notHandled(); -} - -coreSetup.elasticsearch.setUnauthorizedErrorHandler(handler); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md deleted file mode 100644 index 59f302170c53a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [client](./kibana-plugin-core-server.elasticsearchservicestart.client.md) - -## ElasticsearchServiceStart.client property - -A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) - -Signature: - -```typescript -readonly client: IClusterClient; -``` - -## Example - - -```js -const client = core.elasticsearch.client; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md deleted file mode 100644 index 26930c6f02b32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) - -## ElasticsearchServiceStart.createClient property - -Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). - -Signature: - -```typescript -readonly createClient: (type: string, clientConfig?: Partial) => ICustomClusterClient; -``` - -## Example - - -```js -const client = elasticsearch.createClient('my-app-name', config); -const data = await client.asInternalUser.search(); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md deleted file mode 100644 index 66ff94ee9c80d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchservicestart.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) - -## ElasticsearchServiceStart interface - - -Signature: - -```typescript -export interface ElasticsearchServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.elasticsearchservicestart.client.md) | IClusterClient | A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) | -| [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient | Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md deleted file mode 100644 index f8a45fe9a5a9c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) - -## ElasticsearchStatusMeta.incompatibleNodes property - -Signature: - -```typescript -incompatibleNodes: NodesVersionCompatibility['incompatibleNodes']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md deleted file mode 100644 index 82748932c2102..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) - -## ElasticsearchStatusMeta interface - - -Signature: - -```typescript -export interface ElasticsearchStatusMeta -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [incompatibleNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.incompatiblenodes.md) | NodesVersionCompatibility\['incompatibleNodes'\] | | -| [nodesInfoRequestError?](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) | NodesVersionCompatibility\['nodesInfoRequestError'\] | (Optional) | -| [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) | NodesVersionCompatibility\['warningNodes'\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md deleted file mode 100644 index 1b46078a1a453..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [nodesInfoRequestError](./kibana-plugin-core-server.elasticsearchstatusmeta.nodesinforequesterror.md) - -## ElasticsearchStatusMeta.nodesInfoRequestError property - -Signature: - -```typescript -nodesInfoRequestError?: NodesVersionCompatibility['nodesInfoRequestError']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md b/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md deleted file mode 100644 index 7374ccd9e7fa8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) > [warningNodes](./kibana-plugin-core-server.elasticsearchstatusmeta.warningnodes.md) - -## ElasticsearchStatusMeta.warningNodes property - -Signature: - -```typescript -warningNodes: NodesVersionCompatibility['warningNodes']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md deleted file mode 100644 index 102e0c8f64b5a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) > [body](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) - -## ErrorHttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: ResponseError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md deleted file mode 100644 index bbd91156347b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) > [headers](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) - -## ErrorHttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md deleted file mode 100644 index 3a037e71ac1e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.errorhttpresponseoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) - -## ErrorHttpResponseOptions interface - -HTTP response parameters - -Signature: - -```typescript -export interface ErrorHttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.errorhttpresponseoptions.body.md) | ResponseError | (Optional) HTTP message to send to the client | -| [headers?](./kibana-plugin-core-server.errorhttpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md deleted file mode 100644 index ae9df8b406be6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [(constructor)](./kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md) - -## EventLoopDelaysMonitor.(constructor) - -Creating a new instance from EventLoopDelaysMonitor will automatically start tracking event loop delays. - -Signature: - -```typescript -constructor(); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md deleted file mode 100644 index ff9c57787f71d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.collect.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [collect](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) - -## EventLoopDelaysMonitor.collect() method - -Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time `reset` was called or this EventLoopDelaysMonitor instance was created. - -Returns metrics in milliseconds. - -Signature: - -```typescript -collect(): IntervalHistogram; -``` -Returns: - -IntervalHistogram - -{IntervalHistogram} - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md deleted file mode 100644 index e5d35547d3bdb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) - -## EventLoopDelaysMonitor class - -Signature: - -```typescript -export declare class EventLoopDelaysMonitor -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)()](./kibana-plugin-core-server.eventloopdelaysmonitor._constructor_.md) | | Creating a new instance from EventLoopDelaysMonitor will automatically start tracking event loop delays. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [collect()](./kibana-plugin-core-server.eventloopdelaysmonitor.collect.md) | | Collect gathers event loop delays metrics from nodejs perf\_hooks.monitorEventLoopDelay the histogram calculations start from the last time reset was called or this EventLoopDelaysMonitor instance was created.Returns metrics in milliseconds. | -| [reset()](./kibana-plugin-core-server.eventloopdelaysmonitor.reset.md) | | Resets the collected histogram data. | -| [stop()](./kibana-plugin-core-server.eventloopdelaysmonitor.stop.md) | | Disables updating the interval timer for collecting new data points. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md deleted file mode 100644 index a65cc7c99842d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.reset.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [reset](./kibana-plugin-core-server.eventloopdelaysmonitor.reset.md) - -## EventLoopDelaysMonitor.reset() method - -Resets the collected histogram data. - -Signature: - -```typescript -reset(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md b/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md deleted file mode 100644 index d63c963b384e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.eventloopdelaysmonitor.stop.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) > [stop](./kibana-plugin-core-server.eventloopdelaysmonitor.stop.md) - -## EventLoopDelaysMonitor.stop() method - -Disables updating the interval timer for collecting new data points. - -Signature: - -```typescript -stop(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md deleted file mode 100644 index c8816a3deee4d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.getaslabels.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) > [getAsLabels](./kibana-plugin-core-server.executioncontextsetup.getaslabels.md) - -## ExecutionContextSetup.getAsLabels() method - -Signature: - -```typescript -getAsLabels(): apm.Labels; -``` -Returns: - -apm.Labels - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md deleted file mode 100644 index 7fdc4d1ec1d57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) - -## ExecutionContextSetup interface - - -Signature: - -```typescript -export interface ExecutionContextSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getAsLabels()](./kibana-plugin-core-server.executioncontextsetup.getaslabels.md) | | -| [withContext(context, fn)](./kibana-plugin-core-server.executioncontextsetup.withcontext.md) | Keeps track of execution context while the passed function is executed. Data are carried over all async operations spawned by the passed function. The nested calls stack the registered context on top of each other. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md deleted file mode 100644 index 2bfef6db2f907..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextsetup.withcontext.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) > [withContext](./kibana-plugin-core-server.executioncontextsetup.withcontext.md) - -## ExecutionContextSetup.withContext() method - -Keeps track of execution context while the passed function is executed. Data are carried over all async operations spawned by the passed function. The nested calls stack the registered context on top of each other. - -Signature: - -```typescript -withContext(context: KibanaExecutionContext | undefined, fn: (...args: any[]) => R): R; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | KibanaExecutionContext \| undefined | | -| fn | (...args: any\[\]) => R | | - -Returns: - -R - diff --git a/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md b/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md deleted file mode 100644 index 115c09471b3f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.executioncontextstart.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) - -## ExecutionContextStart type - - -Signature: - -```typescript -export declare type ExecutionContextStart = ExecutionContextSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md b/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md deleted file mode 100644 index b2bb3f5928dcc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.exposedtobrowserdescriptor.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ExposedToBrowserDescriptor](./kibana-plugin-core-server.exposedtobrowserdescriptor.md) - -## ExposedToBrowserDescriptor type - -Type defining the list of configuration properties that will be exposed on the client-side Object properties can either be fully exposed - -Signature: - -```typescript -export declare type ExposedToBrowserDescriptor = { - [Key in keyof T]?: T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? // can be nested for objects - ExposedToBrowserDescriptor | boolean : boolean; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md b/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md deleted file mode 100644 index 55d1dc7edc05e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.fakerequest.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FakeRequest](./kibana-plugin-core-server.fakerequest.md) > [headers](./kibana-plugin-core-server.fakerequest.headers.md) - -## FakeRequest.headers property - -Headers used for authentication against Elasticsearch - -Signature: - -```typescript -headers: Headers; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.fakerequest.md b/docs/development/core/server/kibana-plugin-core-server.fakerequest.md deleted file mode 100644 index 6b8bfe33d19c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.fakerequest.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FakeRequest](./kibana-plugin-core-server.fakerequest.md) - -## FakeRequest interface - -Fake request object created manually by Kibana plugins. - -Signature: - -```typescript -export interface FakeRequest -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers](./kibana-plugin-core-server.fakerequest.headers.md) | Headers | Headers used for authentication against Elasticsearch | - diff --git a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md b/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md deleted file mode 100644 index b530874d3678b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) > [deprecationType](./kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md) - -## FeatureDeprecationDetails.deprecationType property - -Signature: - -```typescript -deprecationType?: 'feature' | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md b/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md deleted file mode 100644 index c92f352ce7e5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.featuredeprecationdetails.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) - -## FeatureDeprecationDetails interface - - -Signature: - -```typescript -export interface FeatureDeprecationDetails extends BaseDeprecationDetails -``` -Extends: BaseDeprecationDetails - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecationType?](./kibana-plugin-core-server.featuredeprecationdetails.deprecationtype.md) | 'feature' \| undefined | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md b/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md deleted file mode 100644 index 2f1502a5ea0ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getauthheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetAuthHeaders](./kibana-plugin-core-server.getauthheaders.md) - -## GetAuthHeaders type - -Get headers to authenticate a user against Elasticsearch. - -Signature: - -```typescript -export declare type GetAuthHeaders = (request: KibanaRequest) => AuthHeaders | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getauthstate.md b/docs/development/core/server/kibana-plugin-core-server.getauthstate.md deleted file mode 100644 index 979a6b5b5792b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getauthstate.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetAuthState](./kibana-plugin-core-server.getauthstate.md) - -## GetAuthState type - -Gets authentication state for a request. Returned by `auth` interceptor. - -Signature: - -```typescript -export declare type GetAuthState = (request: KibanaRequest) => { - status: AuthStatus; - state: T; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md deleted file mode 100644 index 70c1864bf905f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.esclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) > [esClient](./kibana-plugin-core-server.getdeprecationscontext.esclient.md) - -## GetDeprecationsContext.esClient property - -Signature: - -```typescript -esClient: IScopedClusterClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md deleted file mode 100644 index 2362966866852..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) - -## GetDeprecationsContext interface - - -Signature: - -```typescript -export interface GetDeprecationsContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [esClient](./kibana-plugin-core-server.getdeprecationscontext.esclient.md) | IScopedClusterClient | | -| [savedObjectsClient](./kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md) | SavedObjectsClientContract | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md b/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md deleted file mode 100644 index 66da52d3b5824..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) > [savedObjectsClient](./kibana-plugin-core-server.getdeprecationscontext.savedobjectsclient.md) - -## GetDeprecationsContext.savedObjectsClient property - -Signature: - -```typescript -savedObjectsClient: SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md deleted file mode 100644 index d31b61f3962c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_id](./kibana-plugin-core-server.getresponse._id.md) - -## GetResponse.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md deleted file mode 100644 index 0353ec1a17b2c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._index.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_index](./kibana-plugin-core-server.getresponse._index.md) - -## GetResponse.\_index property - -Signature: - -```typescript -_index: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md deleted file mode 100644 index 8412302ab727d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md) - -## GetResponse.\_primary\_term property - -Signature: - -```typescript -_primary_term: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md deleted file mode 100644 index 1af3ed31ee112..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_routing](./kibana-plugin-core-server.getresponse._routing.md) - -## GetResponse.\_routing property - -Signature: - -```typescript -_routing?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md deleted file mode 100644 index e8d72563f8149..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md) - -## GetResponse.\_seq\_no property - -Signature: - -```typescript -_seq_no: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md deleted file mode 100644 index 97aacb42992a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._source.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_source](./kibana-plugin-core-server.getresponse._source.md) - -## GetResponse.\_source property - -Signature: - -```typescript -_source: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md deleted file mode 100644 index b3205e2fe91d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_type](./kibana-plugin-core-server.getresponse._type.md) - -## GetResponse.\_type property - -Signature: - -```typescript -_type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md b/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md deleted file mode 100644 index 23d3a8c91f4a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse._version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [\_version](./kibana-plugin-core-server.getresponse._version.md) - -## GetResponse.\_version property - -Signature: - -```typescript -_version: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md b/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md deleted file mode 100644 index 8d34a3e743cca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse.found.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) > [found](./kibana-plugin-core-server.getresponse.found.md) - -## GetResponse.found property - -Signature: - -```typescript -found: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.getresponse.md b/docs/development/core/server/kibana-plugin-core-server.getresponse.md deleted file mode 100644 index 5068be8a5689a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.getresponse.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [GetResponse](./kibana-plugin-core-server.getresponse.md) - -## GetResponse interface - - -Signature: - -```typescript -export interface GetResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.getresponse._id.md) | string | | -| [\_index](./kibana-plugin-core-server.getresponse._index.md) | string | | -| [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md) | number | | -| [\_routing?](./kibana-plugin-core-server.getresponse._routing.md) | string | (Optional) | -| [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md) | number | | -| [\_source](./kibana-plugin-core-server.getresponse._source.md) | T | | -| [\_type](./kibana-plugin-core-server.getresponse._type.md) | string | | -| [\_version](./kibana-plugin-core-server.getresponse._version.md) | number | | -| [found](./kibana-plugin-core-server.getresponse.found.md) | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md b/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md deleted file mode 100644 index 6fef414209d71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlercontexttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md) - -## HandlerContextType type - -Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) to represent the type of the context. - -Signature: - -```typescript -export declare type HandlerContextType> = T extends HandlerFunction ? U : never; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md b/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md deleted file mode 100644 index 2b41e5a978be2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlerfunction.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) - -## HandlerFunction type - -A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) - -Signature: - -```typescript -export declare type HandlerFunction = (context: T, ...args: any[]) => any; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md b/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md deleted file mode 100644 index 3e5a2f24eddc7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.handlerparameters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) - -## HandlerParameters type - -Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md), excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md). - -Signature: - -```typescript -export declare type HandlerParameters> = T extends (context: any, ...args: infer U) => any ? U : never; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.headers_2.md b/docs/development/core/server/kibana-plugin-core-server.headers_2.md deleted file mode 100644 index 398827f2bf3d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.headers_2.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Headers\_2](./kibana-plugin-core-server.headers_2.md) - -## Headers\_2 type - -Http request headers to read. - -Signature: - -```typescript -export declare type Headers = { - [header in KnownHeaders]?: string | string[] | undefined; -} & { - [header: string]: string | string[] | undefined; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md deleted file mode 100644 index 4ea67cf895a27..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) > [get](./kibana-plugin-core-server.httpauth.get.md) - -## HttpAuth.get property - -Gets authentication state for a request. Returned by `auth` interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) - -Signature: - -```typescript -get: GetAuthState; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md deleted file mode 100644 index 54db6bce5f161..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.isauthenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) > [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) - -## HttpAuth.isAuthenticated property - -Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) - -Signature: - -```typescript -isAuthenticated: IsAuthenticated; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpauth.md b/docs/development/core/server/kibana-plugin-core-server.httpauth.md deleted file mode 100644 index 4b47be615c79c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpauth.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpAuth](./kibana-plugin-core-server.httpauth.md) - -## HttpAuth interface - - -Signature: - -```typescript -export interface HttpAuth -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-server.httpauth.get.md) | GetAuthState | Gets authentication state for a request. Returned by auth interceptor. [GetAuthState](./kibana-plugin-core-server.getauthstate.md) | -| [isAuthenticated](./kibana-plugin-core-server.httpauth.isauthenticated.md) | IsAuthenticated | Returns authentication status for a request. [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.md deleted file mode 100644 index 0b1854d7cbcd9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresources.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResources](./kibana-plugin-core-server.httpresources.md) - -## HttpResources interface - -HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. - -Signature: - -```typescript -export interface HttpResources -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [register](./kibana-plugin-core-server.httpresources.register.md) | <P, Q, B, Context extends RequestHandlerContext = RequestHandlerContext>(route: RouteConfig<P, Q, B, 'get'>, handler: HttpResourcesRequestHandler<P, Q, B, Context>) => void | To register a route handler executing passed function to form response. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md deleted file mode 100644 index ee9569aeb37b4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResources](./kibana-plugin-core-server.httpresources.md) > [register](./kibana-plugin-core-server.httpresources.register.md) - -## HttpResources.register property - -To register a route handler executing passed function to form response. - -Signature: - -```typescript -register: (route: RouteConfig, handler: HttpResourcesRequestHandler) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md deleted file mode 100644 index bb6dec504ff42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) > [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) - -## HttpResourcesRenderOptions.headers property - -HTTP Headers with additional information about response. - -Signature: - -```typescript -headers?: ResponseHeaders; -``` - -## Remarks - -All HTML pages are already pre-configured with `content-security-policy` header that cannot be overridden. - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md deleted file mode 100644 index 9fcdc1b338783..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) - -## HttpResourcesRenderOptions interface - -Allows to configure HTTP response parameters - -Signature: - -```typescript -export interface HttpResourcesRenderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers?](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md deleted file mode 100644 index 49854ac003860..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesrequesthandler.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) - -## HttpResourcesRequestHandler type - -Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. - -Signature: - -```typescript -export declare type HttpResourcesRequestHandler

= RequestHandler; -``` - -## Example - -\`\`\`typescript httpResources.register({ path: '/login', validate: { params: schema.object({ id: schema.string() }), }, }, async (context, request, response) => { //.. return response.renderCoreApp(); }); - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md deleted file mode 100644 index 2ea3ea7e58c78..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesresponseoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) - -## HttpResourcesResponseOptions type - -HTTP Resources response parameters - -Signature: - -```typescript -export declare type HttpResourcesResponseOptions = HttpResponseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md deleted file mode 100644 index 05e7af5dcbedf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) - -## HttpResourcesServiceToolkit interface - -Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. - -Signature: - -```typescript -export interface HttpResourcesServiceToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. | -| [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse> | To respond with HTML page bootstrapping Kibana application. | -| [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom HTML page. | -| [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) | (options: HttpResourcesResponseOptions) => IKibanaResponse | To respond with a custom JS script file. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md deleted file mode 100644 index 3dce9d88c8036..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) - -## HttpResourcesServiceToolkit.renderAnonymousCoreApp property - -To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. - -Signature: - -```typescript -renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md deleted file mode 100644 index eb4f095bc19be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) - -## HttpResourcesServiceToolkit.renderCoreApp property - -To respond with HTML page bootstrapping Kibana application. - -Signature: - -```typescript -renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md deleted file mode 100644 index 325d19625df44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) - -## HttpResourcesServiceToolkit.renderHtml property - -To respond with a custom HTML page. - -Signature: - -```typescript -renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md b/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md deleted file mode 100644 index f8d4418fc6cba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) > [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) - -## HttpResourcesServiceToolkit.renderJs property - -To respond with a custom JS script file. - -Signature: - -```typescript -renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md deleted file mode 100644 index bf61be9d7e606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [body](./kibana-plugin-core-server.httpresponseoptions.body.md) - -## HttpResponseOptions.body property - -HTTP message to send to the client - -Signature: - -```typescript -body?: HttpResponsePayload; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md deleted file mode 100644 index 98792c47d564f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [bypassErrorFormat](./kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md) - -## HttpResponseOptions.bypassErrorFormat property - -Bypass the default error formatting - -Signature: - -```typescript -bypassErrorFormat?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md deleted file mode 100644 index 7702c49d07c8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) > [headers](./kibana-plugin-core-server.httpresponseoptions.headers.md) - -## HttpResponseOptions.headers property - -HTTP Headers with additional information about response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md deleted file mode 100644 index 9d10d91244157..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponseoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) - -## HttpResponseOptions interface - -HTTP response parameters - -Signature: - -```typescript -export interface HttpResponseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.httpresponseoptions.body.md) | HttpResponsePayload | (Optional) HTTP message to send to the client | -| [bypassErrorFormat?](./kibana-plugin-core-server.httpresponseoptions.bypasserrorformat.md) | boolean | (Optional) Bypass the default error formatting | -| [headers?](./kibana-plugin-core-server.httpresponseoptions.headers.md) | ResponseHeaders | (Optional) HTTP Headers with additional information about response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md b/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md deleted file mode 100644 index 8f72dc4daa8a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpresponsepayload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) - -## HttpResponsePayload type - -Data send to the client as a response payload. - -Signature: - -```typescript -export declare type HttpResponsePayload = undefined | string | Record | Buffer | Stream; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md deleted file mode 100644 index 194a8aea16269..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.hostname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [hostname](./kibana-plugin-core-server.httpserverinfo.hostname.md) - -## HttpServerInfo.hostname property - -The hostname of the server - -Signature: - -```typescript -hostname: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md deleted file mode 100644 index 151cb5d272403..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) - -## HttpServerInfo interface - -Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md). - -Signature: - -```typescript -export interface HttpServerInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hostname](./kibana-plugin-core-server.httpserverinfo.hostname.md) | string | The hostname of the server | -| [name](./kibana-plugin-core-server.httpserverinfo.name.md) | string | The name of the Kibana server | -| [port](./kibana-plugin-core-server.httpserverinfo.port.md) | number | The port the server is listening on | -| [protocol](./kibana-plugin-core-server.httpserverinfo.protocol.md) | 'http' \| 'https' \| 'socket' | The protocol used by the server | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md deleted file mode 100644 index c35ed626f12c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [name](./kibana-plugin-core-server.httpserverinfo.name.md) - -## HttpServerInfo.name property - -The name of the Kibana server - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md deleted file mode 100644 index e8ad0e8186fea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.port.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [port](./kibana-plugin-core-server.httpserverinfo.port.md) - -## HttpServerInfo.port property - -The port the server is listening on - -Signature: - -```typescript -port: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md b/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md deleted file mode 100644 index 9e7c672c2361f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpserverinfo.protocol.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) > [protocol](./kibana-plugin-core-server.httpserverinfo.protocol.md) - -## HttpServerInfo.protocol property - -The protocol used by the server - -Signature: - -```typescript -protocol: 'http' | 'https' | 'socket'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md deleted file mode 100644 index 9864f67d70a43..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [basePath](./kibana-plugin-core-server.httpservicepreboot.basepath.md) - -## HttpServicePreboot.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md deleted file mode 100644 index 0c9636b8eb634..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [getServerInfo](./kibana-plugin-core-server.httpservicepreboot.getserverinfo.md) - -## HttpServicePreboot.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running preboot http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md deleted file mode 100644 index 87c62b63014e1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.md +++ /dev/null @@ -1,80 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) - -## HttpServicePreboot interface - -Kibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality allows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins can define HTTP routes at this stage. - -Signature: - -```typescript -export interface HttpServicePreboot -``` - -## Example - -To handle an incoming request in your preboot plugin you should: - Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. To opt out of validating the request, specify `false`. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; -``` -- Declare a function to respond to incoming request. The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. Any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. - -```ts -const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { - const data = await findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) { - return response.notFound(); - } - // creates a command to send found data to the client and set response headers - return response.ok({ - body: data, - headers: { 'content-type': 'application/json' } - }); -} -``` -\* - Acquire `preboot` [IRouter](./kibana-plugin-core-server.irouter.md) instance and register route handler for GET request to 'path/{id}' path. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; - -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; - -httpPreboot.registerRoutes('my-plugin', (router) => { - router.get({ path: 'path/{id}', validate }, async (context, request, response) => { - const data = await findObject(request.params.id); - if (!data) { - return response.notFound(); - } - return response.ok({ - body: data, - headers: { 'content-type': 'application/json' } - }); - }); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [basePath](./kibana-plugin-core-server.httpservicepreboot.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [getServerInfo](./kibana-plugin-core-server.httpservicepreboot.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running preboot http server. | - -## Methods - -| Method | Description | -| --- | --- | -| [registerRoutes(path, callback)](./kibana-plugin-core-server.httpservicepreboot.registerroutes.md) | Provides ability to acquire preboot [IRouter](./kibana-plugin-core-server.irouter.md) instance for a particular top-level path and register handler functions for any number of nested routes. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md b/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md deleted file mode 100644 index dd90074fad39a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicepreboot.registerroutes.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) > [registerRoutes](./kibana-plugin-core-server.httpservicepreboot.registerroutes.md) - -## HttpServicePreboot.registerRoutes() method - -Provides ability to acquire `preboot` [IRouter](./kibana-plugin-core-server.irouter.md) instance for a particular top-level path and register handler functions for any number of nested routes. - -Signature: - -```typescript -registerRoutes(path: string, callback: (router: IRouter) => void): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | -| callback | (router: IRouter) => void | | - -Returns: - -void - -## Remarks - -Each route can have only one handler function, which is executed when the route is matched. See the [IRouter](./kibana-plugin-core-server.irouter.md) documentation for more information. - -## Example - - -```ts -registerRoutes('my-plugin', (router) => { - // handler is called when '/my-plugin/path' resource is requested with `GET` method - router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); -}); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md deleted file mode 100644 index ba10af1b8555a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [basePath](./kibana-plugin-core-server.httpservicesetup.basepath.md) - -## HttpServiceSetup.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md deleted file mode 100644 index bdc0acf1c4864..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [createCookieSessionStorageFactory](./kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md) - -## HttpServiceSetup.createCookieSessionStorageFactory property - -Creates cookie based session storage factory [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) - -Signature: - -```typescript -createCookieSessionStorageFactory: (cookieOptions: SessionStorageCookieOptions) => Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md deleted file mode 100644 index 7bdc7cd2e4e33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.createrouter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [createRouter](./kibana-plugin-core-server.httpservicesetup.createrouter.md) - -## HttpServiceSetup.createRouter property - -Provides ability to declare a handler function for a particular path and HTTP request method. - -Signature: - -```typescript -createRouter: () => IRouter; -``` - -## Remarks - -Each route can have only one handler function, which is executed when the route is matched. See the [IRouter](./kibana-plugin-core-server.irouter.md) documentation for more information. - -## Example - - -```ts -const router = createRouter(); -// handler is called when '/path' resource is requested with `GET` method -router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md deleted file mode 100644 index 1e2b987e667c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.csp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [csp](./kibana-plugin-core-server.httpservicesetup.csp.md) - -## HttpServiceSetup.csp property - -The CSP config used for Kibana. - -Signature: - -```typescript -csp: ICspConfig; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md deleted file mode 100644 index 9e257062722a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [getServerInfo](./kibana-plugin-core-server.httpservicesetup.getserverinfo.md) - -## HttpServiceSetup.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md deleted file mode 100644 index bb03887e547e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md +++ /dev/null @@ -1,91 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) - -## HttpServiceSetup interface - -Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to `hapi` server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. - -Signature: - -```typescript -export interface HttpServiceSetup -``` - -## Example - -To handle an incoming request in your plugin you should: - Create a `Router` instance. - -```ts -const router = httpSetup.createRouter(); -``` -- Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. To opt out of validating the request, specify `false`. - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; -``` -- Declare a function to respond to incoming request. The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. Unlike, `hapi` route handler in the Legacy platform, any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. - -```ts -const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { - const data = await findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) return response.notFound(); - // creates a command to send found data to the client and set response headers - return response.ok({ - body: data, - headers: { - 'content-type': 'application/json' - } - }); -} -``` -- Register route handler for GET request to 'path/{id}' path - -```ts -import { schema, TypeOf } from '@kbn/config-schema'; -const router = httpSetup.createRouter(); - -const validate = { - params: schema.object({ - id: schema.string(), - }), -}; - -router.get({ - path: 'path/{id}', - validate -}, -async (context, request, response) => { - const data = await findObject(request.params.id); - if (!data) return response.notFound(); - return response.ok({ - body: data, - headers: { - 'content-type': 'application/json' - } - }); -}); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [basePath](./kibana-plugin-core-server.httpservicesetup.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [createCookieSessionStorageFactory](./kibana-plugin-core-server.httpservicesetup.createcookiesessionstoragefactory.md) | <T>(cookieOptions: SessionStorageCookieOptions<T>) => Promise<SessionStorageFactory<T>> | Creates cookie based session storage factory [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) | -| [createRouter](./kibana-plugin-core-server.httpservicesetup.createrouter.md) | <Context extends RequestHandlerContext = RequestHandlerContext>() => IRouter<Context> | Provides ability to declare a handler function for a particular path and HTTP request method. | -| [csp](./kibana-plugin-core-server.httpservicesetup.csp.md) | ICspConfig | The CSP config used for Kibana. | -| [getServerInfo](./kibana-plugin-core-server.httpservicesetup.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. | -| [registerAuth](./kibana-plugin-core-server.httpservicesetup.registerauth.md) | (handler: AuthenticationHandler) => void | To define custom authentication and/or authorization mechanism for incoming requests. | -| [registerOnPostAuth](./kibana-plugin-core-server.httpservicesetup.registeronpostauth.md) | (handler: OnPostAuthHandler) => void | To define custom logic after Auth interceptor did make sure a user has access to the requested resource. | -| [registerOnPreAuth](./kibana-plugin-core-server.httpservicesetup.registeronpreauth.md) | (handler: OnPreAuthHandler) => void | To define custom logic to perform for incoming requests before the Auth interceptor performs a check that user has access to requested resources. | -| [registerOnPreResponse](./kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md) | (handler: OnPreResponseHandler) => void | To define custom logic to perform for the server response. | -| [registerOnPreRouting](./kibana-plugin-core-server.httpservicesetup.registeronprerouting.md) | (handler: OnPreRoutingHandler) => void | To define custom logic to perform for incoming requests before server performs a route lookup. | -| [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) | <Context extends RequestHandlerContext, ContextName extends keyof Omit<Context, 'resolve'>>(contextName: ContextName, provider: RequestHandlerContextProvider<Context, ContextName>) => RequestHandlerContextContainer | Register a context provider for a route handler. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md deleted file mode 100644 index d209b526afd76..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerAuth](./kibana-plugin-core-server.httpservicesetup.registerauth.md) - -## HttpServiceSetup.registerAuth property - -To define custom authentication and/or authorization mechanism for incoming requests. - -Signature: - -```typescript -registerAuth: (handler: AuthenticationHandler) => void; -``` - -## Remarks - -A handler should return a state to associate with the incoming request. The state can be retrieved later via http.auth.get(..) Only one AuthenticationHandler can be registered. See [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md deleted file mode 100644 index 41b82f428948a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpostauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPostAuth](./kibana-plugin-core-server.httpservicesetup.registeronpostauth.md) - -## HttpServiceSetup.registerOnPostAuth property - -To define custom logic after Auth interceptor did make sure a user has access to the requested resource. - -Signature: - -```typescript -registerOnPostAuth: (handler: OnPostAuthHandler) => void; -``` - -## Remarks - -The auth state is available at stage via http.auth.get(..) Can register any number of registerOnPostAuth, which are called in sequence (from the first registered to the last). See [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md deleted file mode 100644 index 57b1833df5e03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreauth.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreAuth](./kibana-plugin-core-server.httpservicesetup.registeronpreauth.md) - -## HttpServiceSetup.registerOnPreAuth property - -To define custom logic to perform for incoming requests before the Auth interceptor performs a check that user has access to requested resources. - -Signature: - -```typescript -registerOnPreAuth: (handler: OnPreAuthHandler) => void; -``` - -## Remarks - -Can register any number of registerOnPreAuth, which are called in sequence (from the first registered to the last). See [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md deleted file mode 100644 index 118bc06cc726c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreResponse](./kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md) - -## HttpServiceSetup.registerOnPreResponse property - -To define custom logic to perform for the server response. - -Signature: - -```typescript -registerOnPreResponse: (handler: OnPreResponseHandler) => void; -``` - -## Remarks - -Doesn't provide the whole response object. Supports extending response with custom headers. See [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md deleted file mode 100644 index bdf5f15828669..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registeronprerouting.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerOnPreRouting](./kibana-plugin-core-server.httpservicesetup.registeronprerouting.md) - -## HttpServiceSetup.registerOnPreRouting property - -To define custom logic to perform for incoming requests before server performs a route lookup. - -Signature: - -```typescript -registerOnPreRouting: (handler: OnPreRoutingHandler) => void; -``` - -## Remarks - -It's the only place when you can forward a request to another URL right on the server. Can register any number of registerOnPreRouting, which are called in sequence (from the first registered to the last). See [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md deleted file mode 100644 index 23e009864dcd6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) > [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) - -## HttpServiceSetup.registerRouteHandlerContext property - -Register a context provider for a route handler. - -Signature: - -```typescript -registerRouteHandlerContext: >(contextName: ContextName, provider: RequestHandlerContextProvider) => RequestHandlerContextContainer; -``` - -## Example - - -```ts - // my-plugin.ts - interface MyRequestHandlerContext extends RequestHandlerContext { - myApp: { search(id: string): Promise }; - } - deps.http.registerRouteHandlerContext( - 'myApp', - (context, req) => { - async function search (id: string) { - return await context.elasticsearch.client.asCurrentUser.find(id); - } - return { search }; - } - ); - -// my-route-handler.ts - import type { MyRequestHandlerContext } from './my-plugin.ts'; - const router = createRouter(); - router.get({ path: '/', validate: false }, async (context, req, res) => { - const response = await context.myApp.search(...); - return res.ok(response); - }); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md deleted file mode 100644 index f7dffee2e125c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [auth](./kibana-plugin-core-server.httpservicestart.auth.md) - -## HttpServiceStart.auth property - -Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md) - -Signature: - -```typescript -auth: HttpAuth; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md deleted file mode 100644 index e8b2a0fc2cbaa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.basepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [basePath](./kibana-plugin-core-server.httpservicestart.basepath.md) - -## HttpServiceStart.basePath property - -Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). - -Signature: - -```typescript -basePath: IBasePath; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md deleted file mode 100644 index a95c8da64fdb0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.getserverinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) > [getServerInfo](./kibana-plugin-core-server.httpservicestart.getserverinfo.md) - -## HttpServiceStart.getServerInfo property - -Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. - -Signature: - -```typescript -getServerInfo: () => HttpServerInfo; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md b/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md deleted file mode 100644 index de6c259c7f7a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.httpservicestart.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) - -## HttpServiceStart interface - - -Signature: - -```typescript -export interface HttpServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [auth](./kibana-plugin-core-server.httpservicestart.auth.md) | HttpAuth | Auth status. See [HttpAuth](./kibana-plugin-core-server.httpauth.md) | -| [basePath](./kibana-plugin-core-server.httpservicestart.basepath.md) | IBasePath | Access or manipulate the Kibana base path See [IBasePath](./kibana-plugin-core-server.ibasepath.md). | -| [getServerInfo](./kibana-plugin-core-server.httpservicestart.getserverinfo.md) | () => HttpServerInfo | Provides common [information](./kibana-plugin-core-server.httpserverinfo.md) about the running http server. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md deleted file mode 100644 index fa98f34c6ac5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.getlocale.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) > [getLocale](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) - -## I18nServiceSetup.getLocale() method - -Return the locale currently in use. - -Signature: - -```typescript -getLocale(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md deleted file mode 100644 index ebdb0babc3af7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) > [getTranslationFiles](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) - -## I18nServiceSetup.getTranslationFiles() method - -Return the absolute paths to translation files currently in use. - -Signature: - -```typescript -getTranslationFiles(): string[]; -``` -Returns: - -string\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md deleted file mode 100644 index f68b7877953e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.i18nservicesetup.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) - -## I18nServiceSetup interface - - -Signature: - -```typescript -export interface I18nServiceSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [getLocale()](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) | Return the locale currently in use. | -| [getTranslationFiles()](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) | Return the absolute paths to translation files currently in use. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ibasepath.md b/docs/development/core/server/kibana-plugin-core-server.ibasepath.md deleted file mode 100644 index 7f0c551d1da28..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ibasepath.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IBasePath](./kibana-plugin-core-server.ibasepath.md) - -## IBasePath type - -Access or manipulate the Kibana base path - -[BasePath](./kibana-plugin-core-server.basepath.md) - -Signature: - -```typescript -export declare type IBasePath = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md deleted file mode 100644 index c7adc345af5a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) - -## IClusterClient.asInternalUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user - -Signature: - -```typescript -readonly asInternalUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md deleted file mode 100644 index 301fcbfee5858..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) - -## IClusterClient.asScoped property - -Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) - -Signature: - -```typescript -asScoped: (request: ScopeableRequest) => IScopedClusterClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md deleted file mode 100644 index 969a32d96a3a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) - -## IClusterClient interface - -Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`). - -Signature: - -```typescript -export interface IClusterClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user | -| [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) | (request: ScopeableRequest) => IScopedClusterClient | Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md deleted file mode 100644 index ac13b86295f6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.createhandler.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) > [createHandler](./kibana-plugin-core-server.icontextcontainer.createhandler.md) - -## IContextContainer.createHandler() method - -Create a new handler function pre-wired to context for the plugin. - -Signature: - -```typescript -createHandler(pluginOpaqueId: PluginOpaqueId, handler: RequestHandler): (...rest: HandlerParameters) => ShallowPromise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginOpaqueId | PluginOpaqueId | The plugin opaque ID for the plugin that registers this handler. | -| handler | RequestHandler | Handler function to pass context object to. | - -Returns: - -(...rest: HandlerParameters<RequestHandler>) => ShallowPromise<ReturnType<RequestHandler>> - -A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of the `handler` return value. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md deleted file mode 100644 index 99cddecb38d43..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.md +++ /dev/null @@ -1,79 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) - -## IContextContainer interface - -An object that handles registration of context providers and configuring handlers with context. - -Signature: - -```typescript -export interface IContextContainer -``` - -## Remarks - -A [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares. - -Contexts providers are executed in the order they were registered. Each provider gets access to context values provided by any plugins that it depends on. - -In order to configure a handler with context, you must call the [IContextContainer.createHandler()](./kibana-plugin-core-server.icontextcontainer.createhandler.md) function and use the returned handler which will automatically build a context object when called. - -When registering context or creating handlers, the \_calling plugin's opaque id\_ must be provided. This id is passed in via the plugin's initializer and can be accessed from the [PluginInitializerContext.opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) Note this should NOT be the context service owner's id, but the plugin that is actually registering the context or handler. - -```ts -// Correct -class MyPlugin { - private readonly handlers = new Map(); - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(pluginOpaqueId, contextName, provider) { - this.contextContainer.registerContext(pluginOpaqueId, contextName, provider); - }, - registerRoute(pluginOpaqueId, path, handler) { - this.handlers.set( - path, - this.contextContainer.createHandler(pluginOpaqueId, handler) - ); - } - } - } -} - -// Incorrect -class MyPlugin { - private readonly handlers = new Map(); - - constructor(private readonly initContext: PluginInitializerContext) {} - - setup(core) { - this.contextContainer = core.context.createContextContainer(); - return { - registerContext(contextName, provider) { - // BUG! - // This would leak this context to all handlers rather that only plugins that depend on the calling plugin. - this.contextContainer.registerContext(this.initContext.opaqueId, contextName, provider); - }, - registerRoute(path, handler) { - this.handlers.set( - path, - // BUG! - // This handler will not receive any contexts provided by other dependencies of the calling plugin. - this.contextContainer.createHandler(this.initContext.opaqueId, handler) - ); - } - } - } -} -``` - -## Methods - -| Method | Description | -| --- | --- | -| [createHandler(pluginOpaqueId, handler)](./kibana-plugin-core-server.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. | -| [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-core-server.icontextcontainer.registercontext.md) | Register a new context provider. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md b/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md deleted file mode 100644 index 32b177df2b2ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextcontainer.registercontext.md +++ /dev/null @@ -1,34 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) > [registerContext](./kibana-plugin-core-server.icontextcontainer.registercontext.md) - -## IContextContainer.registerContext() method - -Register a new context provider. - -Signature: - -```typescript -registerContext(pluginOpaqueId: PluginOpaqueId, contextName: ContextName, provider: IContextProvider): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pluginOpaqueId | PluginOpaqueId | The plugin opaque ID for the plugin that registers this context. | -| contextName | ContextName | The key of the TContext object this provider supplies the value for. | -| provider | IContextProvider<Context, ContextName> | A [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) to be called each time a new context is created. | - -Returns: - -this - -The [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) for method chaining. - -## Remarks - -The value (or resolved Promise value) returned by the `provider` function will be attached to the context object on the key specified by `contextName`. - -Throws an exception if more than one provider is registered for the same `contextName`. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md b/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md deleted file mode 100644 index eb2ec3cbf90b8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) - -## IContextProvider type - -A function that returns a context value for a specific key of given context type. - -Signature: - -```typescript -export declare type IContextProvider = (context: Omit, ...rest: HandlerParameters) => MaybePromise>; -``` - -## Remarks - -This function will be called each time a new context is built for a handler invocation. - diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md deleted file mode 100644 index 42b177c348afe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.disableembedding.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) - -## ICspConfig.disableEmbedding property - -Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. - -Signature: - -```typescript -readonly disableEmbedding: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md deleted file mode 100644 index 779a0184e9fb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.header.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [header](./kibana-plugin-core-server.icspconfig.header.md) - -## ICspConfig.header property - -The CSP rules in a formatted directives string for use in a `Content-Security-Policy` header. - -Signature: - -```typescript -readonly header: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.md deleted file mode 100644 index d5667900a41e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) - -## ICspConfig interface - -CSP configuration for use in Kibana. - -Signature: - -```typescript -export interface ICspConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) | boolean | Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. | -| [header](./kibana-plugin-core-server.icspconfig.header.md) | string | The CSP rules in a formatted directives string for use in a Content-Security-Policy header. | -| [strict](./kibana-plugin-core-server.icspconfig.strict.md) | boolean | Specify whether browsers that do not support CSP should be able to use Kibana. Use true to block and false to allow. | -| [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) | boolean | Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md deleted file mode 100644 index d8ea8ec377831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.strict.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [strict](./kibana-plugin-core-server.icspconfig.strict.md) - -## ICspConfig.strict property - -Specify whether browsers that do not support CSP should be able to use Kibana. Use `true` to block and `false` to allow. - -Signature: - -```typescript -readonly strict: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md b/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md deleted file mode 100644 index 84286262bcbf2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) - -## ICspConfig.warnLegacyBrowsers property - -Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. - -Signature: - -```typescript -readonly warnLegacyBrowsers: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md deleted file mode 100644 index 5fa2e93cca75b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) > [close](./kibana-plugin-core-server.icustomclusterclient.close.md) - -## ICustomClusterClient.close property - -Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. - -Signature: - -```typescript -close: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md deleted file mode 100644 index 1c65137d1ddc1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) - -## ICustomClusterClient interface - -See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) - -Signature: - -```typescript -export interface ICustomClusterClient extends IClusterClient -``` -Extends: IClusterClient - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [close](./kibana-plugin-core-server.icustomclusterclient.close.md) | () => Promise<void> | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md deleted file mode 100644 index 2ab3f52b9b553..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) - -## IExecutionContextContainer interface - - -Signature: - -```typescript -export interface IExecutionContextContainer -``` - -## Methods - -| Method | Description | -| --- | --- | -| [toJSON()](./kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md) | | -| [toString()](./kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md) | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md deleted file mode 100644 index a561e6c319408..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) > [toJSON](./kibana-plugin-core-server.iexecutioncontextcontainer.tojson.md) - -## IExecutionContextContainer.toJSON() method - -Signature: - -```typescript -toJSON(): Readonly; -``` -Returns: - -Readonly<KibanaExecutionContext> - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md b/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md deleted file mode 100644 index 666da5bef3969..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) > [toString](./kibana-plugin-core-server.iexecutioncontextcontainer.tostring.md) - -## IExecutionContextContainer.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md deleted file mode 100644 index b5490a9548dc1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) - -## IExternalUrlConfig interface - -External Url configuration for use in Kibana. - -Signature: - -```typescript -export interface IExternalUrlConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) | IExternalUrlPolicy\[\] | A set of policies describing which external urls are allowed. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md deleted file mode 100644 index b5b6f07038076..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlconfig.policy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) > [policy](./kibana-plugin-core-server.iexternalurlconfig.policy.md) - -## IExternalUrlConfig.policy property - -A set of policies describing which external urls are allowed. - -Signature: - -```typescript -readonly policy: IExternalUrlPolicy[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md deleted file mode 100644 index 47d3dbf83f2b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.allow.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) - -## IExternalUrlPolicy.allow property - -Indicates if this policy allows or denies access to the described destination. - -Signature: - -```typescript -allow: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md deleted file mode 100644 index a549f80509474..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.host.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [host](./kibana-plugin-core-server.iexternalurlpolicy.host.md) - -## IExternalUrlPolicy.host property - -Optional host describing the external destination. May be combined with `protocol`. - -Signature: - -```typescript -host?: string; -``` - -## Example - - -```ts -// allows access to all of google.com, using any protocol. -allow: true, -host: 'google.com' -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md deleted file mode 100644 index 45f7798eaf336..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) - -## IExternalUrlPolicy interface - -A policy describing whether access to an external destination is allowed. - -Signature: - -```typescript -export interface IExternalUrlPolicy -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allow](./kibana-plugin-core-server.iexternalurlpolicy.allow.md) | boolean | Indicates if this policy allows or denies access to the described destination. | -| [host?](./kibana-plugin-core-server.iexternalurlpolicy.host.md) | string | (Optional) Optional host describing the external destination. May be combined with protocol. | -| [protocol?](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) | string | (Optional) Optional protocol describing the external destination. May be combined with host. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md b/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md deleted file mode 100644 index 86f6e6164de4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iexternalurlpolicy.protocol.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) > [protocol](./kibana-plugin-core-server.iexternalurlpolicy.protocol.md) - -## IExternalUrlPolicy.protocol property - -Optional protocol describing the external destination. May be combined with `host`. - -Signature: - -```typescript -protocol?: string; -``` - -## Example - - -```ts -// allows access to all destinations over the `https` protocol. -allow: true, -protocol: 'https' -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md deleted file mode 100644 index c71f5360834e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) - -## IKibanaResponse interface - -A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution - -Signature: - -```typescript -export interface IKibanaResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [options](./kibana-plugin-core-server.ikibanaresponse.options.md) | HttpResponseOptions | | -| [payload?](./kibana-plugin-core-server.ikibanaresponse.payload.md) | T | (Optional) | -| [status](./kibana-plugin-core-server.ikibanaresponse.status.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md deleted file mode 100644 index a91224a11282d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.options.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [options](./kibana-plugin-core-server.ikibanaresponse.options.md) - -## IKibanaResponse.options property - -Signature: - -```typescript -readonly options: HttpResponseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md deleted file mode 100644 index 2475402bfb9fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.payload.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [payload](./kibana-plugin-core-server.ikibanaresponse.payload.md) - -## IKibanaResponse.payload property - -Signature: - -```typescript -readonly payload?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md b/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md deleted file mode 100644 index 2d7494d0e22b5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanaresponse.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) > [status](./kibana-plugin-core-server.ikibanaresponse.status.md) - -## IKibanaResponse.status property - -Signature: - -```typescript -readonly status: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md deleted file mode 100644 index 930179acf399a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorizationerror.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [authorizationError](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) - -## IKibanaSocket.authorizationError property - -The reason why the peer's certificate has not been verified. This property becomes available only when `authorized` is `false`. - -Signature: - -```typescript -readonly authorizationError?: Error; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md deleted file mode 100644 index 5ead5a8556c92..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.authorized.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [authorized](./kibana-plugin-core-server.ikibanasocket.authorized.md) - -## IKibanaSocket.authorized property - -Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is `undefined`. - -Signature: - -```typescript -readonly authorized?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md deleted file mode 100644 index 9f0dce061bcfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate.md) - -## IKibanaSocket.getPeerCertificate() method - -Signature: - -```typescript -getPeerCertificate(detailed: true): DetailedPeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | true | | - -Returns: - -DetailedPeerCertificate \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md deleted file mode 100644 index 363fce50251d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md) - -## IKibanaSocket.getPeerCertificate() method - -Signature: - -```typescript -getPeerCertificate(detailed: false): PeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | false | | - -Returns: - -PeerCertificate \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md deleted file mode 100644 index 24b11b6966000..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getPeerCertificate](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md) - -## IKibanaSocket.getPeerCertificate() method - -Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. - -Signature: - -```typescript -getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| detailed | boolean | If true; the full chain with issuer property will be returned. | - -Returns: - -PeerCertificate \| DetailedPeerCertificate \| null - -An object representing the peer's certificate. - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md deleted file mode 100644 index d605f2fd21bef..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.getprotocol.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [getProtocol](./kibana-plugin-core-server.ikibanasocket.getprotocol.md) - -## IKibanaSocket.getProtocol() method - -Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL\_get\_version.html for more information. - -Signature: - -```typescript -getProtocol(): string | null; -``` -Returns: - -string \| null - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md deleted file mode 100644 index bc8f59df9d211..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) - -## IKibanaSocket interface - -A tiny abstraction for TCP socket. - -Signature: - -```typescript -export interface IKibanaSocket -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authorizationError?](./kibana-plugin-core-server.ikibanasocket.authorizationerror.md) | Error | (Optional) The reason why the peer's certificate has not been verified. This property becomes available only when authorized is false. | -| [authorized?](./kibana-plugin-core-server.ikibanasocket.authorized.md) | boolean | (Optional) Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is undefined. | - -## Methods - -| Method | Description | -| --- | --- | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate.md) | | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_1.md) | | -| [getPeerCertificate(detailed)](./kibana-plugin-core-server.ikibanasocket.getpeercertificate_2.md) | Returns an object representing the peer's certificate. The returned object has some properties corresponding to the field of the certificate. If detailed argument is true the full chain with issuer property will be returned, if false only the top certificate without issuer property. If the peer does not provide a certificate, it returns null. | -| [getProtocol()](./kibana-plugin-core-server.ikibanasocket.getprotocol.md) | Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL\_get\_version.html for more information. | -| [renegotiate(options)](./kibana-plugin-core-server.ikibanasocket.renegotiate.md) | Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md b/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md deleted file mode 100644 index b4addde9b3179..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.ikibanasocket.renegotiate.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) > [renegotiate](./kibana-plugin-core-server.ikibanasocket.renegotiate.md) - -## IKibanaSocket.renegotiate() method - -Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. - -Signature: - -```typescript -renegotiate(options: { - rejectUnauthorized?: boolean; - requestCert?: boolean; - }): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | { rejectUnauthorized?: boolean; requestCert?: boolean; } | The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). | - -Returns: - -Promise<void> - -A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed. - diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md deleted file mode 100644 index 664bdb8f24d7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.exceeds.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) - -## IntervalHistogram.exceeds property - -Signature: - -```typescript -exceeds: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md deleted file mode 100644 index 00fa8dcb84430..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.fromtimestamp.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) - -## IntervalHistogram.fromTimestamp property - -Signature: - -```typescript -fromTimestamp: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md deleted file mode 100644 index 58e75fc2ba437..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.lastupdatedat.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) - -## IntervalHistogram.lastUpdatedAt property - -Signature: - -```typescript -lastUpdatedAt: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md deleted file mode 100644 index 14d7fe6b68c4b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.max.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [max](./kibana-plugin-core-server.intervalhistogram.max.md) - -## IntervalHistogram.max property - -Signature: - -```typescript -max: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md deleted file mode 100644 index 56a87a1577e98..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) - -## IntervalHistogram interface - -an IntervalHistogram object that samples and reports the event loop delay over time. The delays will be reported in milliseconds. - -Signature: - -```typescript -export interface IntervalHistogram -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [exceeds](./kibana-plugin-core-server.intervalhistogram.exceeds.md) | number | | -| [fromTimestamp](./kibana-plugin-core-server.intervalhistogram.fromtimestamp.md) | string | | -| [lastUpdatedAt](./kibana-plugin-core-server.intervalhistogram.lastupdatedat.md) | string | | -| [max](./kibana-plugin-core-server.intervalhistogram.max.md) | number | | -| [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) | number | | -| [min](./kibana-plugin-core-server.intervalhistogram.min.md) | number | | -| [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) | { 50: number; 75: number; 95: number; 99: number; } | | -| [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md deleted file mode 100644 index e6794bfa5fe52..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.mean.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [mean](./kibana-plugin-core-server.intervalhistogram.mean.md) - -## IntervalHistogram.mean property - -Signature: - -```typescript -mean: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md deleted file mode 100644 index d0eb929601f18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.min.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [min](./kibana-plugin-core-server.intervalhistogram.min.md) - -## IntervalHistogram.min property - -Signature: - -```typescript -min: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md deleted file mode 100644 index b0adc9531c0b1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.percentiles.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [percentiles](./kibana-plugin-core-server.intervalhistogram.percentiles.md) - -## IntervalHistogram.percentiles property - -Signature: - -```typescript -percentiles: { - 50: number; - 75: number; - 95: number; - 99: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md b/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md deleted file mode 100644 index bca5ab56cb237..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.intervalhistogram.stddev.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) > [stddev](./kibana-plugin-core-server.intervalhistogram.stddev.md) - -## IntervalHistogram.stddev property - -Signature: - -```typescript -stddev: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md deleted file mode 100644 index dc2af11f9f9d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.isanonymouspage.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) > [isAnonymousPage](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) - -## IRenderOptions.isAnonymousPage property - -Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. `false` by default. - -Signature: - -```typescript -isAnonymousPage?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md b/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md deleted file mode 100644 index 84539a6aa73ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irenderoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) - -## IRenderOptions interface - - -Signature: - -```typescript -export interface IRenderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isAnonymousPage?](./kibana-plugin-core-server.irenderoptions.isanonymouspage.md) | boolean | (Optional) Set whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata. false by default. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md b/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md deleted file mode 100644 index a7b6dd5bc294e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.delete.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [delete](./kibana-plugin-core-server.irouter.delete.md) - -## IRouter.delete property - -Register a route handler for `DELETE` request. - -Signature: - -```typescript -delete: RouteRegistrar<'delete', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md b/docs/development/core/server/kibana-plugin-core-server.irouter.get.md deleted file mode 100644 index 7db694b38da47..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [get](./kibana-plugin-core-server.irouter.get.md) - -## IRouter.get property - -Register a route handler for `GET` request. - -Signature: - -```typescript -get: RouteRegistrar<'get', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md b/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md deleted file mode 100644 index 35d109975c83a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.handlelegacyerrors.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) - -## IRouter.handleLegacyErrors property - -Wrap a router handler to catch and converts legacy boom errors to proper custom errors. - -Signature: - -```typescript -handleLegacyErrors: RequestHandlerWrapper; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.md b/docs/development/core/server/kibana-plugin-core-server.irouter.md deleted file mode 100644 index a751ea399c5a9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) - -## IRouter interface - -Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations. - -Signature: - -```typescript -export interface IRouter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [delete](./kibana-plugin-core-server.irouter.delete.md) | RouteRegistrar<'delete', Context> | Register a route handler for DELETE request. | -| [get](./kibana-plugin-core-server.irouter.get.md) | RouteRegistrar<'get', Context> | Register a route handler for GET request. | -| [handleLegacyErrors](./kibana-plugin-core-server.irouter.handlelegacyerrors.md) | RequestHandlerWrapper | Wrap a router handler to catch and converts legacy boom errors to proper custom errors. | -| [patch](./kibana-plugin-core-server.irouter.patch.md) | RouteRegistrar<'patch', Context> | Register a route handler for PATCH request. | -| [post](./kibana-plugin-core-server.irouter.post.md) | RouteRegistrar<'post', Context> | Register a route handler for POST request. | -| [put](./kibana-plugin-core-server.irouter.put.md) | RouteRegistrar<'put', Context> | Register a route handler for PUT request. | -| [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) | string | Resulted path | - diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md b/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md deleted file mode 100644 index b353079630ecb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.patch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [patch](./kibana-plugin-core-server.irouter.patch.md) - -## IRouter.patch property - -Register a route handler for `PATCH` request. - -Signature: - -```typescript -patch: RouteRegistrar<'patch', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md b/docs/development/core/server/kibana-plugin-core-server.irouter.post.md deleted file mode 100644 index 94c703ad6f339..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.post.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [post](./kibana-plugin-core-server.irouter.post.md) - -## IRouter.post property - -Register a route handler for `POST` request. - -Signature: - -```typescript -post: RouteRegistrar<'post', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md b/docs/development/core/server/kibana-plugin-core-server.irouter.put.md deleted file mode 100644 index 702ff3ff61bb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.put.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [put](./kibana-plugin-core-server.irouter.put.md) - -## IRouter.put property - -Register a route handler for `PUT` request. - -Signature: - -```typescript -put: RouteRegistrar<'put', Context>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md b/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md deleted file mode 100644 index c326e33b01f1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.irouter.routerpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IRouter](./kibana-plugin-core-server.irouter.md) > [routerPath](./kibana-plugin-core-server.irouter.routerpath.md) - -## IRouter.routerPath property - -Resulted path - -Signature: - -```typescript -routerPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md b/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md deleted file mode 100644 index 0c2d7fab8b579..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isauthenticated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) - -## IsAuthenticated type - -Returns authentication status for a request. - -Signature: - -```typescript -export declare type IsAuthenticated = (request: KibanaRequest) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md deleted file mode 100644 index 826583a85ed8a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) > [exportByObjects](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) - -## ISavedObjectsExporter.exportByObjects() method - -Generates an export stream for given object references. - -See the [options](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) for more detailed information. - -Signature: - -```typescript -exportByObjects(options: SavedObjectsExportByObjectOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsExportByObjectOptions | | - -Returns: - -Promise<Readable> - -## Exceptions - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md deleted file mode 100644 index b1f354e7914f7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) > [exportByTypes](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) - -## ISavedObjectsExporter.exportByTypes() method - -Generates an export stream for given types. - -See the [options](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) for more detailed information. - -Signature: - -```typescript -exportByTypes(options: SavedObjectsExportByTypeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsExportByTypeOptions | | - -Returns: - -Promise<Readable> - -## Exceptions - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md deleted file mode 100644 index 4e9643ef8261d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsexporter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) - -## ISavedObjectsExporter interface - -Utility class used to export savedObjects. - -Signature: - -```typescript -export interface ISavedObjectsExporter -``` - -## Methods - -| Method | Description | -| --- | --- | -| [exportByObjects(options)](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) | Generates an export stream for given object references.See the [options](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) for more detailed information. | -| [exportByTypes(options)](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) | Generates an export stream for given types.See the [options](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) for more detailed information. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md deleted file mode 100644 index 0622bb511eb8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.import.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) > [import](./kibana-plugin-core-server.isavedobjectsimporter.import.md) - -## ISavedObjectsImporter.import() method - -Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. - -Signature: - -```typescript -import(options: SavedObjectsImportOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsImportOptions | | - -Returns: - -Promise<SavedObjectsImportResponse> - -## Exceptions - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md deleted file mode 100644 index 93e0d5092ebf9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) - -## ISavedObjectsImporter interface - -Utility class used to import savedObjects. - -Signature: - -```typescript -export interface ISavedObjectsImporter -``` - -## Methods - -| Method | Description | -| --- | --- | -| [import(options)](./kibana-plugin-core-server.isavedobjectsimporter.import.md) | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. | -| [resolveImportErrors(options)](./kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md) | Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md deleted file mode 100644 index 9d25439e61c81..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) > [resolveImportErrors](./kibana-plugin-core-server.isavedobjectsimporter.resolveimporterrors.md) - -## ISavedObjectsImporter.resolveImportErrors() method - -Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. - -Signature: - -```typescript -resolveImportErrors(options: SavedObjectsResolveImportErrorsOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsResolveImportErrorsOptions | | - -Returns: - -Promise<SavedObjectsImportResponse> - -## Exceptions - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md deleted file mode 100644 index f7cfab446eeca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.close.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) > [close](./kibana-plugin-core-server.isavedobjectspointintimefinder.close.md) - -## ISavedObjectsPointInTimeFinder.close property - -Closes the Point-In-Time associated with this finder instance. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -close: () => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md deleted file mode 100644 index 29d4668becffc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.find.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) > [find](./kibana-plugin-core-server.isavedobjectspointintimefinder.find.md) - -## ISavedObjectsPointInTimeFinder.find property - -An async generator which wraps calls to `savedObjectsClient.find` and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage` size. - -Signature: - -```typescript -find: () => AsyncGenerator>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md deleted file mode 100644 index 748ffbdc3c4e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectspointintimefinder.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) - -## ISavedObjectsPointInTimeFinder interface - - -Signature: - -```typescript -export interface ISavedObjectsPointInTimeFinder -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [close](./kibana-plugin-core-server.isavedobjectspointintimefinder.close.md) | () => Promise<void> | Closes the Point-In-Time associated with this finder instance.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [find](./kibana-plugin-core-server.isavedobjectspointintimefinder.find.md) | () => AsyncGenerator<SavedObjectsFindResponse<T, A>> | An async generator which wraps calls to savedObjectsClient.find and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage size. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md deleted file mode 100644 index 90cd2d605da8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjectsrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectsRepository](./kibana-plugin-core-server.isavedobjectsrepository.md) - -## ISavedObjectsRepository type - -See [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) - -Signature: - -```typescript -export declare type ISavedObjectsRepository = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md deleted file mode 100644 index f9c621885c001..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.isavedobjecttyperegistry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ISavedObjectTypeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - -## ISavedObjectTypeRegistry type - -See [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) for documentation. - -Signature: - -```typescript -export declare type ISavedObjectTypeRegistry = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md deleted file mode 100644 index ddc6357bb8835..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) - -## IScopedClusterClient.asCurrentUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. - -Signature: - -```typescript -readonly asCurrentUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md deleted file mode 100644 index f7f308aa13161..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) - -## IScopedClusterClient.asInternalUser property - -A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. - -Signature: - -```typescript -readonly asInternalUser: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md b/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md deleted file mode 100644 index f0d75f2f08fe4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) - -## IScopedClusterClient interface - -Serves the same purpose as the normal [cluster client](./kibana-plugin-core-server.iclusterclient.md) but exposes an additional `asCurrentUser` method that doesn't use credentials of the Kibana internal user (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API instead. - -Signature: - -```typescript -export interface IScopedClusterClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. | -| [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) | ElasticsearchClient | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md deleted file mode 100644 index 36252e37d2f5e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.get.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [get](./kibana-plugin-core-server.iuisettingsclient.get.md) - -## IUiSettingsClient.get property - -Retrieves uiSettings values set by the user with fallbacks to default values if not specified. - -Signature: - -```typescript -get: (key: string) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md deleted file mode 100644 index d1cc06dd83484..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getall.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getAll](./kibana-plugin-core-server.iuisettingsclient.getall.md) - -## IUiSettingsClient.getAll property - -Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. - -Signature: - -```typescript -getAll: () => Promise>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md deleted file mode 100644 index 71a2bbf88472e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getregistered.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getRegistered](./kibana-plugin-core-server.iuisettingsclient.getregistered.md) - -## IUiSettingsClient.getRegistered property - -Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) - -Signature: - -```typescript -getRegistered: () => Readonly>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md deleted file mode 100644 index 93d5f33709379..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.getuserprovided.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [getUserProvided](./kibana-plugin-core-server.iuisettingsclient.getuserprovided.md) - -## IUiSettingsClient.getUserProvided property - -Retrieves a set of all uiSettings values set by the user. - -Signature: - -```typescript -getUserProvided: () => Promise>>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md deleted file mode 100644 index c9af118895f13..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.isoverridden.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [isOverridden](./kibana-plugin-core-server.iuisettingsclient.isoverridden.md) - -## IUiSettingsClient.isOverridden property - -Shows whether the uiSettings value set by the user. - -Signature: - -```typescript -isOverridden: (key: string) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md deleted file mode 100644 index a6f263e0b0f55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.issensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [isSensitive](./kibana-plugin-core-server.iuisettingsclient.issensitive.md) - -## IUiSettingsClient.isSensitive property - -Shows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values. - -Signature: - -```typescript -isSensitive: (key: string) => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md deleted file mode 100644 index ad7819719e14a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) - -## IUiSettingsClient interface - -Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. - -Signature: - -```typescript -export interface IUiSettingsClient -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [get](./kibana-plugin-core-server.iuisettingsclient.get.md) | <T = any>(key: string) => Promise<T> | Retrieves uiSettings values set by the user with fallbacks to default values if not specified. | -| [getAll](./kibana-plugin-core-server.iuisettingsclient.getall.md) | <T = any>() => Promise<Record<string, T>> | Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. | -| [getRegistered](./kibana-plugin-core-server.iuisettingsclient.getregistered.md) | () => Readonly<Record<string, PublicUiSettingsParams>> | Returns registered uiSettings values [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) | -| [getUserProvided](./kibana-plugin-core-server.iuisettingsclient.getuserprovided.md) | <T = any>() => Promise<Record<string, UserProvidedValues<T>>> | Retrieves a set of all uiSettings values set by the user. | -| [isOverridden](./kibana-plugin-core-server.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. | -| [isSensitive](./kibana-plugin-core-server.iuisettingsclient.issensitive.md) | (key: string) => boolean | Shows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values. | -| [remove](./kibana-plugin-core-server.iuisettingsclient.remove.md) | (key: string) => Promise<void> | Removes uiSettings value by key. | -| [removeMany](./kibana-plugin-core-server.iuisettingsclient.removemany.md) | (keys: string\[\]) => Promise<void> | Removes multiple uiSettings values by keys. | -| [set](./kibana-plugin-core-server.iuisettingsclient.set.md) | (key: string, value: any) => Promise<void> | Writes uiSettings value and marks it as set by the user. | -| [setMany](./kibana-plugin-core-server.iuisettingsclient.setmany.md) | (changes: Record<string, any>) => Promise<void> | Writes multiple uiSettings values and marks them as set by the user. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md deleted file mode 100644 index 3496e30470eab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.remove.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [remove](./kibana-plugin-core-server.iuisettingsclient.remove.md) - -## IUiSettingsClient.remove property - -Removes uiSettings value by key. - -Signature: - -```typescript -remove: (key: string) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md deleted file mode 100644 index 8b76ea5cdec07..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.removemany.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [removeMany](./kibana-plugin-core-server.iuisettingsclient.removemany.md) - -## IUiSettingsClient.removeMany property - -Removes multiple uiSettings values by keys. - -Signature: - -```typescript -removeMany: (keys: string[]) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md deleted file mode 100644 index c5254d1df8040..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.set.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [set](./kibana-plugin-core-server.iuisettingsclient.set.md) - -## IUiSettingsClient.set property - -Writes uiSettings value and marks it as set by the user. - -Signature: - -```typescript -set: (key: string, value: any) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md b/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md deleted file mode 100644 index cb03889c7f4bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.iuisettingsclient.setmany.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) > [setMany](./kibana-plugin-core-server.iuisettingsclient.setmany.md) - -## IUiSettingsClient.setMany property - -Writes multiple uiSettings values and marks them as set by the user. - -Signature: - -```typescript -setMany: (changes: Record) => Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md b/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md deleted file mode 100644 index 792af8f693869..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanaexecutioncontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaExecutionContext](./kibana-plugin-core-server.kibanaexecutioncontext.md) - -## KibanaExecutionContext type - -Represents a meta-information about a Kibana entity initiating a search request. - -Signature: - -```typescript -export declare type KibanaExecutionContext = { - readonly type?: string; - readonly name?: string; - readonly page?: string; - readonly id?: string; - readonly description?: string; - readonly url?: string; - child?: KibanaExecutionContext; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md deleted file mode 100644 index 682d6c87629fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest._constructor_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [(constructor)](./kibana-plugin-core-server.kibanarequest._constructor_.md) - -## KibanaRequest.(constructor) - -Constructs a new instance of the `KibanaRequest` class - -Signature: - -```typescript -constructor(request: Request, params: Params, query: Query, body: Body, withoutSecretHeaders: boolean); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | -| params | Params | | -| query | Query | | -| body | Body | | -| withoutSecretHeaders | boolean | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md deleted file mode 100644 index 7049c06dfa06c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [auth](./kibana-plugin-core-server.kibanarequest.auth.md) - -## KibanaRequest.auth property - -Signature: - -```typescript -readonly auth: { - isAuthenticated: boolean; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md deleted file mode 100644 index 968395af9a3f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.body.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [body](./kibana-plugin-core-server.kibanarequest.body.md) - -## KibanaRequest.body property - -Signature: - -```typescript -readonly body: Body; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md deleted file mode 100644 index 5662348242384..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.events.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [events](./kibana-plugin-core-server.kibanarequest.events.md) - -## KibanaRequest.events property - -Request events [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) - -Signature: - -```typescript -readonly events: KibanaRequestEvents; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md deleted file mode 100644 index 3dfb9b49e83ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.headers.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [headers](./kibana-plugin-core-server.kibanarequest.headers.md) - -## KibanaRequest.headers property - -Readonly copy of incoming request headers. - -Signature: - -```typescript -readonly headers: Headers; -``` - -## Remarks - -This property will contain a `filtered` copy of request headers. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md deleted file mode 100644 index 8cad5972cc164..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.id.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [id](./kibana-plugin-core-server.kibanarequest.id.md) - -## KibanaRequest.id property - -A identifier to identify this request. - -Signature: - -```typescript -readonly id: string; -``` - -## Remarks - -Depending on the user's configuration, this value may be sourced from the incoming request's `X-Opaque-Id` header which is not guaranteed to be unique per request. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md deleted file mode 100644 index e5ac6e23b2116..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.issystemrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [isSystemRequest](./kibana-plugin-core-server.kibanarequest.issystemrequest.md) - -## KibanaRequest.isSystemRequest property - -Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the `HttpFetchOptions#asSystemRequest` option. - -Signature: - -```typescript -readonly isSystemRequest: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md deleted file mode 100644 index f4e2dda2d5499..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) - -## KibanaRequest class - -Kibana specific abstraction for an incoming request. - -Signature: - -```typescript -export declare class KibanaRequest -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(request, params, query, body, withoutSecretHeaders)](./kibana-plugin-core-server.kibanarequest._constructor_.md) | | Constructs a new instance of the KibanaRequest class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [auth](./kibana-plugin-core-server.kibanarequest.auth.md) | | { isAuthenticated: boolean; } | | -| [body](./kibana-plugin-core-server.kibanarequest.body.md) | | Body | | -| [events](./kibana-plugin-core-server.kibanarequest.events.md) | | KibanaRequestEvents | Request events [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | -| [headers](./kibana-plugin-core-server.kibanarequest.headers.md) | | Headers | Readonly copy of incoming request headers. | -| [id](./kibana-plugin-core-server.kibanarequest.id.md) | | string | A identifier to identify this request. | -| [isSystemRequest](./kibana-plugin-core-server.kibanarequest.issystemrequest.md) | | boolean | Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the HttpFetchOptions#asSystemRequest option. | -| [params](./kibana-plugin-core-server.kibanarequest.params.md) | | Params | | -| [query](./kibana-plugin-core-server.kibanarequest.query.md) | | Query | | -| [rewrittenUrl?](./kibana-plugin-core-server.kibanarequest.rewrittenurl.md) | | URL | (Optional) URL rewritten in onPreRouting request interceptor. | -| [route](./kibana-plugin-core-server.kibanarequest.route.md) | | RecursiveReadonly<KibanaRequestRoute<Method>> | matched route details | -| [socket](./kibana-plugin-core-server.kibanarequest.socket.md) | | IKibanaSocket | [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) | -| [url](./kibana-plugin-core-server.kibanarequest.url.md) | | URL | a WHATWG URL standard object. | -| [uuid](./kibana-plugin-core-server.kibanarequest.uuid.md) | | string | A UUID to identify this request. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md deleted file mode 100644 index ff2e4ac2f11eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.params.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [params](./kibana-plugin-core-server.kibanarequest.params.md) - -## KibanaRequest.params property - -Signature: - -```typescript -readonly params: Params; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md deleted file mode 100644 index b111aa3d66137..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.query.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [query](./kibana-plugin-core-server.kibanarequest.query.md) - -## KibanaRequest.query property - -Signature: - -```typescript -readonly query: Query; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md deleted file mode 100644 index fb547330ee6ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.rewrittenurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [rewrittenUrl](./kibana-plugin-core-server.kibanarequest.rewrittenurl.md) - -## KibanaRequest.rewrittenUrl property - -URL rewritten in onPreRouting request interceptor. - -Signature: - -```typescript -readonly rewrittenUrl?: URL; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md deleted file mode 100644 index b98844775abcc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.route.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [route](./kibana-plugin-core-server.kibanarequest.route.md) - -## KibanaRequest.route property - -matched route details - -Signature: - -```typescript -readonly route: RecursiveReadonly>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md deleted file mode 100644 index 2e18cc336d222..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.socket.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [socket](./kibana-plugin-core-server.kibanarequest.socket.md) - -## KibanaRequest.socket property - -[IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) - -Signature: - -```typescript -readonly socket: IKibanaSocket; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md deleted file mode 100644 index b72760e272bb2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [url](./kibana-plugin-core-server.kibanarequest.url.md) - -## KibanaRequest.url property - -a WHATWG URL standard object. - -Signature: - -```typescript -readonly url: URL; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md deleted file mode 100644 index 8b980b82d0adb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequest.uuid.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) > [uuid](./kibana-plugin-core-server.kibanarequest.uuid.md) - -## KibanaRequest.uuid property - -A UUID to identify this request. - -Signature: - -```typescript -readonly uuid: string; -``` - -## Remarks - -This value is NOT sourced from the incoming request's `X-Opaque-Id` header. it is always a UUID uniquely identifying the request. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md deleted file mode 100644 index ea16a0529f9f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.aborted_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) > [aborted$](./kibana-plugin-core-server.kibanarequestevents.aborted_.md) - -## KibanaRequestEvents.aborted$ property - -Observable that emits once if and when the request has been aborted. - -Signature: - -```typescript -aborted$: Observable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md deleted file mode 100644 index c9f8ab11f6b12..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.completed_.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) > [completed$](./kibana-plugin-core-server.kibanarequestevents.completed_.md) - -## KibanaRequestEvents.completed$ property - -Observable that emits once if and when the request has been completely handled. - -Signature: - -```typescript -completed$: Observable; -``` - -## Remarks - -The request may be considered completed if: - A response has been sent to the client; or - The request was aborted. - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md deleted file mode 100644 index c61e4aeec7c85..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestevents.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) - -## KibanaRequestEvents interface - -Request events. - -Signature: - -```typescript -export interface KibanaRequestEvents -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aborted$](./kibana-plugin-core-server.kibanarequestevents.aborted_.md) | Observable<void> | Observable that emits once if and when the request has been aborted. | -| [completed$](./kibana-plugin-core-server.kibanarequestevents.completed_.md) | Observable<void> | Observable that emits once if and when the request has been completely handled. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md deleted file mode 100644 index 196c352e21f8a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) - -## KibanaRequestRoute interface - -Request specific route information exposed to a handler. - -Signature: - -```typescript -export interface KibanaRequestRoute -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [method](./kibana-plugin-core-server.kibanarequestroute.method.md) | Method | | -| [options](./kibana-plugin-core-server.kibanarequestroute.options.md) | KibanaRequestRouteOptions<Method> | | -| [path](./kibana-plugin-core-server.kibanarequestroute.path.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md deleted file mode 100644 index a1549df34d1b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [method](./kibana-plugin-core-server.kibanarequestroute.method.md) - -## KibanaRequestRoute.method property - -Signature: - -```typescript -method: Method; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md deleted file mode 100644 index 4d2b4253c69a3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.options.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [options](./kibana-plugin-core-server.kibanarequestroute.options.md) - -## KibanaRequestRoute.options property - -Signature: - -```typescript -options: KibanaRequestRouteOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md deleted file mode 100644 index 32357ba4534a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestroute.path.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) > [path](./kibana-plugin-core-server.kibanarequestroute.path.md) - -## KibanaRequestRoute.path property - -Signature: - -```typescript -path: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md b/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md deleted file mode 100644 index f3d77d930cd9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanarequestrouteoptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KibanaRequestRouteOptions](./kibana-plugin-core-server.kibanarequestrouteoptions.md) - -## KibanaRequestRouteOptions type - -Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. - -Signature: - -```typescript -export declare type KibanaRequestRouteOptions = Method extends 'get' | 'options' ? Required, 'body'>> : Required>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md b/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md deleted file mode 100644 index e02f208ae86ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md +++ /dev/null @@ -1,130 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [kibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) - -## kibanaResponseFactory variable - -Set of helpers used to create `KibanaResponse` to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution. - -Signature: - -```typescript -kibanaResponseFactory: { - custom: | Buffer | Error | { - message: string | Error; - attributes?: ResponseErrorAttributes | undefined; - } | Stream | undefined>(options: CustomHttpResponseOptions) => KibanaResponse; - badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; - unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; - forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; - notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; - conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; - customError: (options: CustomHttpResponseOptions) => KibanaResponse; - redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; - ok: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; - accepted: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; - noContent: (options?: HttpResponseOptions) => KibanaResponse; -} -``` - -## Example - -1. Successful response. Supported types of response body are: - `undefined`, no content to send. - `string`, send text - `JSON`, send JSON object, HTTP server will throw if given object is not valid (has circular references, for example) - `Stream` send data stream - `Buffer` send binary stream - -```js -return response.ok(); -return response.ok({ body: 'ack' }); -return response.ok({ body: { id: '1' } }); -return response.ok({ body: Buffer.from(...) }); - -const stream = new Stream.PassThrough(); -fs.createReadStream('./file').pipe(stream); -return res.ok({ body: stream }); -``` -HTTP headers are configurable via response factory parameter `options` [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md). - -```js -return response.ok({ - body: { id: '1' }, - headers: { - 'content-type': 'application/json' - } -}); -``` -2. Redirection response. Redirection URL is configures via 'Location' header. - -```js -return response.redirected({ - body: 'The document has moved', - headers: { - location: '/new-url', - }, -}); -``` -3. Error response. You may pass an error message to the client, where error message can be: - `string` send message text - `Error` send the message text of given Error object. - `{ message: string | Error, attributes: {data: Record, ...} }` - send message text and attach additional error data. - -```js -return response.unauthorized({ - body: 'User has no access to the requested resource.', - headers: { - 'WWW-Authenticate': 'challenge', - } -}) -return response.badRequest(); -return response.badRequest({ body: 'validation error' }); - -try { - // ... -} catch(error){ - return response.badRequest({ body: error }); -} - -return response.badRequest({ - body:{ - message: 'validation error', - attributes: { - requestBody: request.body, - failedFields: validationResult - } - } -}); - -try { - // ... -} catch(error) { - return response.badRequest({ - body: error - }); -} - -``` -4. Custom response. `ResponseFactory` may not cover your use case, so you can use the `custom` function to customize the response. - -```js -return response.custom({ - body: 'ok', - statusCode: 201, - headers: { - location: '/created-url' - } -}) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.knownheaders.md b/docs/development/core/server/kibana-plugin-core-server.knownheaders.md deleted file mode 100644 index cc7ca472e5777..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.knownheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [KnownHeaders](./kibana-plugin-core-server.knownheaders.md) - -## KnownHeaders type - -Set of well-known HTTP headers. - -Signature: - -```typescript -export declare type KnownHeaders = KnownKeys; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md b/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md deleted file mode 100644 index c78b998aef9e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.lifecycleresponsefactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [LifecycleResponseFactory](./kibana-plugin-core-server.lifecycleresponsefactory.md) - -## LifecycleResponseFactory type - -Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. - -Signature: - -```typescript -export declare type LifecycleResponseFactory = typeof lifecycleResponseFactory; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md b/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md deleted file mode 100644 index f47d01a2d09e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.makeusagefromschema.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) - -## MakeUsageFromSchema type - -List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to `true` then the actual value of these configs will be reoprted. If parent node or actual config path is set to `false` then the config will be reported as \[redacted\]. - -Signature: - -```typescript -export declare type MakeUsageFromSchema = { - [Key in keyof T]?: T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? MakeUsageFromSchema | boolean : boolean; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md deleted file mode 100644 index 77d61ff7f373b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.md +++ /dev/null @@ -1,338 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) - -## kibana-plugin-core-server package - -The Kibana Core APIs for server-side plugins. - -A plugin requires a `kibana.json` file at it's root directory that follows [the manfiest schema](./kibana-plugin-core-server.pluginmanifest.md) to define static plugin information required to load the plugin. - -A plugin's `server/index` file must contain a named import, `plugin`, that implements [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) which returns an object that implements . - -The plugin integrates with the core system via lifecycle events: `setup`, `start`, and `stop`. In each lifecycle method, the plugin will receive the corresponding core services available (either [CoreSetup](./kibana-plugin-core-server.coresetup.md) or [CoreStart](./kibana-plugin-core-server.corestart.md)) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. - -## Classes - -| Class | Description | -| --- | --- | -| [BasePath](./kibana-plugin-core-server.basepath.md) | Access or manipulate the Kibana base path | -| [CspConfig](./kibana-plugin-core-server.cspconfig.md) | CSP configuration for use in Kibana. | -| [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) | Wrapper of config schema. | -| [EventLoopDelaysMonitor](./kibana-plugin-core-server.eventloopdelaysmonitor.md) | | -| [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) | Kibana specific abstraction for an incoming request. | -| [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) | Error to return when the validation is not successful. | -| [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) | | -| [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | | -| [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) | | -| [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) | | -| [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | | -| [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) | A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. | -| [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) | | -| [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md). | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AuthResultType](./kibana-plugin-core-server.authresulttype.md) | | -| [AuthStatus](./kibana-plugin-core-server.authstatus.md) | Status indicating an outcome of the authentication. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AppCategory](./kibana-plugin-core-server.appcategory.md) | A category definition for nav links to know where to sort them in the left hand nav | -| [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md) | A plugin with asynchronous lifecycle methods. | -| [Authenticated](./kibana-plugin-core-server.authenticated.md) | | -| [AuthNotHandled](./kibana-plugin-core-server.authnothandled.md) | | -| [AuthRedirected](./kibana-plugin-core-server.authredirected.md) | | -| [AuthRedirectedParams](./kibana-plugin-core-server.authredirectedparams.md) | Result of auth redirection. | -| [AuthResultParams](./kibana-plugin-core-server.authresultparams.md) | Result of successful authentication. | -| [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md) | A tool set defining an outcome of Auth interceptor for incoming request. | -| [BaseDeprecationDetails](./kibana-plugin-core-server.basedeprecationdetails.md) | Base properties shared by all types of deprecations | -| [Capabilities](./kibana-plugin-core-server.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. | -| [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | APIs to manage the [Capabilities](./kibana-plugin-core-server.capabilities.md) that will be used by the application.Plugins relying on capabilities to toggle some of their features should register them during the setup phase using the registerProvider method.Plugins having the responsibility to restrict capabilities depending on a given context should register their capabilities switcher using the registerSwitcher method.Refers to the methods documentation for complete description and examples. | -| [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) | APIs to access the application [Capabilities](./kibana-plugin-core-server.capabilities.md). | -| [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) | | -| [ContextSetup](./kibana-plugin-core-server.contextsetup.md) | An object that handles registration of context providers and configuring handlers with context. | -| [CorePreboot](./kibana-plugin-core-server.corepreboot.md) | Context passed to the setup method of preboot plugins. | -| [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) | The core context provided to route handler.Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request | -| [CoreSetup](./kibana-plugin-core-server.coresetup.md) | Context passed to the setup method of standard plugins. | -| [CoreStart](./kibana-plugin-core-server.corestart.md) | Context passed to the plugins start method. | -| [CoreStatus](./kibana-plugin-core-server.corestatus.md) | Status of core services. | -| [CountResponse](./kibana-plugin-core-server.countresponse.md) | | -| [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) | HTTP response parameters for a response with adjustable status code. | -| [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) | | -| [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) | Server-side client that provides access to fetch all Kibana deprecations | -| [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) | UiSettings deprecation field options. | -| [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) | The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version.The Deprecation service is consumed by the upgrade assistant to assist with the upgrade experience.If a deprecated feature can be resolved without manual user intervention. Using correctiveActions.api allows the Upgrade Assistant to use this api to correct the deprecation upon a user trigger. | -| [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) | A limited set of Elasticsearch configuration entries exposed to the preboot plugins at setup. | -| [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) | | -| [ElasticsearchServicePreboot](./kibana-plugin-core-server.elasticsearchservicepreboot.md) | | -| [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) | | -| [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | | -| [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) | | -| [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters | -| [ExecutionContextSetup](./kibana-plugin-core-server.executioncontextsetup.md) | | -| [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. | -| [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) | | -| [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) | | -| [GetResponse](./kibana-plugin-core-server.getresponse.md) | | -| [HttpAuth](./kibana-plugin-core-server.httpauth.md) | | -| [HttpResources](./kibana-plugin-core-server.httpresources.md) | HttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. | -| [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters | -| [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) | Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. | -| [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) | HTTP response parameters | -| [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) | Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md). | -| [HttpServicePreboot](./kibana-plugin-core-server.httpservicepreboot.md) | Kibana HTTP Service provides an abstraction to work with the HTTP stack at the preboot stage. This functionality allows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and preboot plugins can define HTTP routes at this stage. | -| [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to hapi server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. | -| [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) | | -| [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) | | -| [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via asScoped(...)). | -| [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | An object that handles registration of context providers and configuring handlers with context. | -| [ICspConfig](./kibana-plugin-core-server.icspconfig.md) | CSP configuration for use in Kibana. | -| [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) | See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | -| [IExecutionContextContainer](./kibana-plugin-core-server.iexecutioncontextcontainer.md) | | -| [IExternalUrlConfig](./kibana-plugin-core-server.iexternalurlconfig.md) | External Url configuration for use in Kibana. | -| [IExternalUrlPolicy](./kibana-plugin-core-server.iexternalurlpolicy.md) | A policy describing whether access to an external destination is allowed. | -| [IKibanaResponse](./kibana-plugin-core-server.ikibanaresponse.md) | A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution | -| [IKibanaSocket](./kibana-plugin-core-server.ikibanasocket.md) | A tiny abstraction for TCP socket. | -| [IntervalHistogram](./kibana-plugin-core-server.intervalhistogram.md) | an IntervalHistogram object that samples and reports the event loop delay over time. The delays will be reported in milliseconds. | -| [IRenderOptions](./kibana-plugin-core-server.irenderoptions.md) | | -| [IRouter](./kibana-plugin-core-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-core-server.routeconfig.md) and [RequestHandler](./kibana-plugin-core-server.requesthandler.md) for more information about arguments to route registrations. | -| [ISavedObjectsExporter](./kibana-plugin-core-server.isavedobjectsexporter.md) | Utility class used to export savedObjects. | -| [ISavedObjectsImporter](./kibana-plugin-core-server.isavedobjectsimporter.md) | Utility class used to import savedObjects. | -| [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) | | -| [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) | Serves the same purpose as the normal [cluster client](./kibana-plugin-core-server.iclusterclient.md) but exposes an additional asCurrentUser method that doesn't use credentials of the Kibana internal user (as asInternalUser does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API instead. | -| [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) | Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. | -| [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | Request events. | -| [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) | Request specific route information exposed to a handler. | -| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. | -| [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) | | -| [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. | -| [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. | -| [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) | Additional data to extend a response. | -| [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) | Response status code. | -| [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) | Additional data to extend a response when rendering a new body | -| [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) | A tool set defining an outcome of OnPreResponse interceptor for incoming request. | -| [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) | A tool set defining an outcome of OnPreRouting interceptor for incoming request. | -| [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) | Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server. | -| [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) | OS related metrics | -| [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) | Process related metrics | -| [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) | server related metrics | -| [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) | The interface that should be returned by a PluginInitializer for a standard plugin. | -| [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) | Describes a plugin configuration properties. | -| [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. | -| [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. | -| [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) | | -| [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) | The interface that should be returned by a PluginInitializer for a preboot plugin. | -| [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) | Kibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met. | -| [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) | | -| [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Base context passed to a route handler. | -| [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) | \* | -| [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) | Defines a set of additional options for the resolveCapabilities method of [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md). | -| [RouteConfig](./kibana-plugin-core-server.routeconfig.md) | Route specific configuration. | -| [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) | Additional route options. | -| [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) | Additional body options for a route | -| [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) | Validation result factory to be used in the custom validation function to return the valid data or validation errorsSee [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md). | -| [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) | The configuration object to the RouteValidator class. Set params, query and/or body to specify the validation logic to follow for that property. | -| [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) | Additional options for the RouteValidator class to modify its default behaviour. | -| [SavedObject](./kibana-plugin-core-server.savedobject.md) | | -| [SavedObjectAttributes](./kibana-plugin-core-server.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the attributes property. | -| [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) | | -| [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) | Migration context provided when invoking a [migration handler](./kibana-plugin-core-server.savedobjectmigrationfn.md) | -| [SavedObjectMigrationMap](./kibana-plugin-core-server.savedobjectmigrationmap.md) | A map of [migration functions](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions, and they cannot exceed the current Kibana version.For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. | -| [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) | A reference to another saved object. | -| [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) | A returned input object or one of its references, with additional context. | -| [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) | | -| [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) | | -| [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) | | -| [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) | | -| [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) | | -| [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) | | -| [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) | | -| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) | | -| [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) | | -| [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) | | -| [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) | | -| [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) | Options to control the creation of the Saved Objects Client. | -| [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) | Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. | -| [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) | | -| [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) | An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the namespaceType: 'multiple' or namespaceType: 'multiple-isolated' option).Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with the namespaceType: 'multiple'). | -| [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) | Options for collecting references. | -| [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) | The response when object references are collected. | -| [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) | | -| [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) | | -| [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) | | -| [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) | | -| [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) | Options for the [export by objects API](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) | -| [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) | Options for the [export by type API](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) | -| [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) | | -| [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) | Structure of the export result details entry | -| [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) | Context passed down to a [export transform function](./kibana-plugin-core-server.savedobjectsexporttransform.md) | -| [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) | | -| [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) | | -| [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) | Return type of the Saved Objects find() method.\*Note\*: this type is different between the Public and Server Saved Objects clients. | -| [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) | | -| [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) | A warning meant to notify that a specific user action is required to finalize the import of some type of object. The actionUrl must be a path relative to the basePath, and not include it. | -| [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. | -| [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. | -| [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) | Represents a failure to import. | -| [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) | Result from a [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) | -| [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. | -| [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) | Options to control the import operation. | -| [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) | The response describing the result of an import. | -| [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. | -| [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) | A simple informative warning that will be displayed to the user. | -| [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) | Represents a successful import. | -| [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. | -| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. | -| [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) | | -| [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) | | -| [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) | Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md). | -| [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) | | -| [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) | | -| [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) | | -| [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) | | -| [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. | -| [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) | Options that can be specified when using the saved objects serializer to parse a raw document. | -| [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) | | -| [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) | | -| [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) | Factory provided when invoking a [client factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | -| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. | -| [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) | | -| [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. | -| [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. | -| [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) | Meta information about the SavedObjectService's status. Available to plugins via [CoreSetup.status](./kibana-plugin-core-server.coresetup.status.md). | -| [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) | | -| [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) | Configuration options for the [type](./kibana-plugin-core-server.savedobjectstype.md)'s management section. | -| [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. | -| [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) | An object that should have its spaces updated. | -| [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) | Options for the update operation. | -| [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) | The response when objects' spaces are updated. | -| [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) | Details about a specific object's update result. | -| [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) | | -| [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) | | -| [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) | A map of [validation specs](./kibana-plugin-core-server.savedobjectsvalidationspec.md) to be used for a given type. The map's keys must be valid semver versions.Any time you change the schema of a [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md), you should add a new entry to this map for the Kibana version the change was introduced in. | -| [SearchResponse](./kibana-plugin-core-server.searchresponse.md) | | -| [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) | The current status of a service at a point in time. | -| [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) | Return type from a function to validate cookie contents. | -| [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. | -| [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) | Configuration used to create HTTP session storage based on top of cookie mechanism. | -| [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request | -| [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) | | -| [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) | | -| [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) | API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status. | -| [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. | -| [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) | | -| [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | | -| [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) | | -| [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) | | -| [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) | | -| [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) | | -| [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) | Toolkit passed to a [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) used to generate responses from the handler | -| [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) | Describes the values explicitly set by user. | - -## Variables - -| Variable | Description | -| --- | --- | -| [APP\_WRAPPER\_CLASS](./kibana-plugin-core-server.app_wrapper_class.md) | The class name for top level \*and\* nested application wrappers to ensure proper layout | -| [kibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) | Set of helpers used to create KibanaResponse to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution. | -| [mergeSavedObjectMigrationMaps](./kibana-plugin-core-server.mergesavedobjectmigrationmaps.md) | Merges two saved object migration maps.If there is a migration for a given version on only one of the maps, that migration function will be used:mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }If there is a migration for a given version on both maps, the migrations will be composed:mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } | -| [pollEsNodesVersion](./kibana-plugin-core-server.pollesnodesversion.md) | | -| [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md) | The current "level" of availability of a service. | -| [validBodyOutput](./kibana-plugin-core-server.validbodyoutput.md) | The set of valid body.output | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnalyticsServicePreboot](./kibana-plugin-core-server.analyticsservicepreboot.md) | Exposes the public APIs of the AnalyticsClient during the preboot phase | -| [AnalyticsServiceSetup](./kibana-plugin-core-server.analyticsservicesetup.md) | Exposes the public APIs of the AnalyticsClient during the setup phase. | -| [AnalyticsServiceStart](./kibana-plugin-core-server.analyticsservicestart.md) | Exposes the public APIs of the AnalyticsClient during the start phase | -| [AuthenticationHandler](./kibana-plugin-core-server.authenticationhandler.md) | See [AuthToolkit](./kibana-plugin-core-server.authtoolkit.md). | -| [AuthHeaders](./kibana-plugin-core-server.authheaders.md) | Auth Headers map | -| [AuthResult](./kibana-plugin-core-server.authresult.md) | | -| [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) | -| [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md) | | -| [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) | | -| [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) | Set of HTTP methods changing the state of the server. | -| [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md) | Client used to query the elasticsearch cluster. | -| [ElasticsearchClientConfig](./kibana-plugin-core-server.elasticsearchclientconfig.md) | Configuration options to be used to create a [cluster client](./kibana-plugin-core-server.iclusterclient.md) using the [createClient API](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | -| [ExecutionContextStart](./kibana-plugin-core-server.executioncontextstart.md) | | -| [ExposedToBrowserDescriptor](./kibana-plugin-core-server.exposedtobrowserdescriptor.md) | Type defining the list of configuration properties that will be exposed on the client-side Object properties can either be fully exposed | -| [GetAuthHeaders](./kibana-plugin-core-server.getauthheaders.md) | Get headers to authenticate a user against Elasticsearch. | -| [GetAuthState](./kibana-plugin-core-server.getauthstate.md) | Gets authentication state for a request. Returned by auth interceptor. | -| [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md) | Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) to represent the type of the context. | -| [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) | A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | -| [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) | Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md), excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md). | -| [Headers\_2](./kibana-plugin-core-server.headers_2.md) | Http request headers to read. | -| [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) | Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. | -| [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) | HTTP Resources response parameters | -| [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) | Data send to the client as a response payload. | -| [IBasePath](./kibana-plugin-core-server.ibasepath.md) | Access or manipulate the Kibana base path[BasePath](./kibana-plugin-core-server.basepath.md) | -| [IContextProvider](./kibana-plugin-core-server.icontextprovider.md) | A function that returns a context value for a specific key of given context type. | -| [IsAuthenticated](./kibana-plugin-core-server.isauthenticated.md) | Returns authentication status for a request. | -| [ISavedObjectsRepository](./kibana-plugin-core-server.isavedobjectsrepository.md) | See [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | -| [ISavedObjectTypeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) | See [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) for documentation. | -| [KibanaExecutionContext](./kibana-plugin-core-server.kibanaexecutioncontext.md) | Represents a meta-information about a Kibana entity initiating a search request. | -| [KibanaRequestRouteOptions](./kibana-plugin-core-server.kibanarequestrouteoptions.md) | Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. | -| [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) | Creates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client. | -| [KnownHeaders](./kibana-plugin-core-server.knownheaders.md) | Set of well-known HTTP headers. | -| [LifecycleResponseFactory](./kibana-plugin-core-server.lifecycleresponsefactory.md) | Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. | -| [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) | List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to true then the actual value of these configs will be reoprted. If parent node or actual config path is set to false then the config will be reported as \[redacted\]. | -| [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) | APIs to retrieves metrics gathered and exposed by the core platform. | -| [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) | Elasticsearch Refresh setting for mutating operation | -| [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md) | See [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md). | -| [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md) | See [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md). | -| [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md) | See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). | -| [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md) | See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). | -| [PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) | Dedicated type for plugin configuration schema. | -| [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) | The plugin export at the root of a plugin's server directory should conform to this interface. | -| [PublicUiSettingsParams](./kibana-plugin-core-server.publicuisettingsparams.md) | A sub-set of [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) exposed to the client-side. | -| [RedirectResponseOptions](./kibana-plugin-core-server.redirectresponseoptions.md) | HTTP response parameters for redirection response | -| [RequestHandler](./kibana-plugin-core-server.requesthandler.md) | A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) functions. If anything else is returned, or an error is thrown, the HTTP service will automatically log the error and respond 500 - Internal Server Error. | -| [RequestHandlerContextContainer](./kibana-plugin-core-server.requesthandlercontextcontainer.md) | An object that handles registration of http request context providers. | -| [RequestHandlerContextProvider](./kibana-plugin-core-server.requesthandlercontextprovider.md) | Context provider for request handler. Extends request context object with provided functionality or data. | -| [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md) | Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function. | -| [ResponseError](./kibana-plugin-core-server.responseerror.md) | Error message and optional data send to the client in case of error. | -| [ResponseErrorAttributes](./kibana-plugin-core-server.responseerrorattributes.md) | Additional data to provide error details. | -| [ResponseHeaders](./kibana-plugin-core-server.responseheaders.md) | Http response headers to set. | -| [RouteContentType](./kibana-plugin-core-server.routecontenttype.md) | The set of supported parseable Content-Types | -| [RouteMethod](./kibana-plugin-core-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. | -| [RouteRegistrar](./kibana-plugin-core-server.routeregistrar.md) | Route handler common definition | -| [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) | The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. | -| [RouteValidationSpec](./kibana-plugin-core-server.routevalidationspec.md) | Allowed property validation options: either @kbn/config-schema validations or custom validation functionsSee [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) for custom validation. | -| [RouteValidatorFullConfig](./kibana-plugin-core-server.routevalidatorfullconfig.md) | Route validations config and options merged into one object | -| [SafeRouteMethod](./kibana-plugin-core-server.saferoutemethod.md) | Set of HTTP methods not changing the state of the server. | -| [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) | Type definition for a Saved Object attribute value | -| [SavedObjectAttributeSingle](./kibana-plugin-core-server.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) | -| [SavedObjectMigrationFn](./kibana-plugin-core-server.savedobjectmigrationfn.md) | A migration function for a [saved object type](./kibana-plugin-core-server.savedobjectstype.md) used to migrate it to a given version | -| [SavedObjectSanitizedDoc](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) | Describes Saved Object documents that have passed through the migration framework and are guaranteed to have a references root property. | -| [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.\#\# SavedObjectsClient errorsSince the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md)Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the isXYZError() helpers exposed at SavedObjectsErrorHelpers should be used to understand and manage error responses from the SavedObjectsClient.Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for error.body.error.type or doing substring checks on error.body.error.reason, just use the helpers to understand the meaning of the error:\`\`\`js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }// always rethrow the error unless you handle it throw error; \`\`\`\#\#\# 404s from missing indexFrom the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistence and that index might be missing.At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | -| [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md) | Describes the factory used to create instances of the Saved Objects Client. | -| [SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) | Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md). | -| [SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. | -| [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) | | -| [SavedObjectsCreatePointInTimeFinderOptions](./kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md) | | -| [SavedObjectsExportTransform](./kibana-plugin-core-server.savedobjectsexporttransform.md) | Transformation function used to mutate the exported objects of the associated type.A type's export transform function will be executed once per user-initiated export, for all objects of that type. | -| [SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md) | Describe a [saved object type mapping](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) field.Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation | -| [SavedObjectsImportHook](./kibana-plugin-core-server.savedobjectsimporthook.md) | A hook associated with a specific saved object type, that will be invoked during the import process. The hook will have access to the objects of the registered type.Currently, the only supported feature for import hooks is to return warnings to be displayed in the UI when the import succeeds. The only interactions the hook can have with the import process is via the hook's response. Mutating the objects inside the hook's code will have no effect. | -| [SavedObjectsImportWarning](./kibana-plugin-core-server.savedobjectsimportwarning.md) | Composite type of all the possible types of import warnings.See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) for more details. | -| [SavedObjectsNamespaceType](./kibana-plugin-core-server.savedobjectsnamespacetype.md) | The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. | -| [SavedObjectsValidationSpec](./kibana-plugin-core-server.savedobjectsvalidationspec.md) | Allows for validating properties using @kbn/config-schema validations. | -| [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) | If defined, allows a type to run a search query and return a query filter that may match any documents which may be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which are no longer needed and may slow the migration process.If this hook fails, the migration will proceed without these documents having been filtered out, so this should not be used as a guarantee that these documents have been deleted.Experimental and subject to change | -| [SavedObjectUnsanitizedDoc](./kibana-plugin-core-server.savedobjectunsanitizeddoc.md) | Describes Saved Object documents from Kibana < 7.0.0 which don't have a references root property defined. This type should only be used in migrations. | -| [ScopeableRequest](./kibana-plugin-core-server.scopeablerequest.md) | A user credentials container. It accommodates the necessary auth credentials to impersonate the current user.See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md). | -| [ServiceStatusLevel](./kibana-plugin-core-server.servicestatuslevel.md) | A convenience type that represents the union of each value in [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md). | -| [SharedGlobalConfig](./kibana-plugin-core-server.sharedglobalconfig.md) | | -| [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers. Promise will not resolve until Core and plugin dependencies have completed start. This should only be used inside handlers registered during setup that will only be executed after start lifecycle. | -| [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) | UI element type to represent the settings. | -| [UnauthorizedError](./kibana-plugin-core-server.unauthorizederror.md) | | -| [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) | A handler used to handle unauthorized error returned by elasticsearch | -| [UnauthorizedErrorHandlerResult](./kibana-plugin-core-server.unauthorizederrorhandlerresult.md) | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md b/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md deleted file mode 100644 index 68cd580b57882..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.mergesavedobjectmigrationmaps.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [mergeSavedObjectMigrationMaps](./kibana-plugin-core-server.mergesavedobjectmigrationmaps.md) - -## mergeSavedObjectMigrationMaps variable - -Merges two saved object migration maps. - -If there is a migration for a given version on only one of the maps, that migration function will be used: - -mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g } - -If there is a migration for a given version on both maps, the migrations will be composed: - -mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } - -Signature: - -```typescript -mergeSavedObjectMigrationMaps: (map1: SavedObjectMigrationMap, map2: SavedObjectMigrationMap) => SavedObjectMigrationMap -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md deleted file mode 100644 index 6f05526b66c83..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.collectioninterval.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) - -## MetricsServiceSetup.collectionInterval property - -Interval metrics are collected in milliseconds - -Signature: - -```typescript -readonly collectionInterval: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md deleted file mode 100644 index 0db06b231f60e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) > [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) - -## MetricsServiceSetup.getOpsMetrics$ property - -Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time, based on the `opts.interval` configuration property. - -Signature: - -```typescript -getOpsMetrics$: () => Observable; -``` - -## Example - - -```ts -core.metrics.getOpsMetrics$().subscribe(metrics => { - // do something with the metrics -}) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md deleted file mode 100644 index d9b05589ab6a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) - -## MetricsServiceSetup interface - -APIs to retrieves metrics gathered and exposed by the core platform. - -Signature: - -```typescript -export interface MetricsServiceSetup -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) | number | Interval metrics are collected in milliseconds | -| [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) | () => Observable<OpsMetrics> | Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's start phase, and a new value every fixed interval of time, based on the opts.interval configuration property. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md deleted file mode 100644 index 8b3280d528c18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.metricsservicestart.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) - -## MetricsServiceStart type - -APIs to retrieves metrics gathered and exposed by the core platform. - -Signature: - -```typescript -export declare type MetricsServiceStart = MetricsServiceSetup; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md b/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md deleted file mode 100644 index 6fb93e39c9805..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.mutatingoperationrefreshsetting.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) - -## MutatingOperationRefreshSetting type - -Elasticsearch Refresh setting for mutating operation - -Signature: - -```typescript -export declare type MutatingOperationRefreshSetting = boolean | 'wait_for'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md deleted file mode 100644 index 8e7298d28801c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [incompatibleNodes](./kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md) - -## NodesVersionCompatibility.incompatibleNodes property - -Signature: - -```typescript -incompatibleNodes: NodeInfo[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md deleted file mode 100644 index 82a4800a3b4b6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [isCompatible](./kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md) - -## NodesVersionCompatibility.isCompatible property - -Signature: - -```typescript -isCompatible: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md deleted file mode 100644 index 347f2d3474b11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [kibanaVersion](./kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md) - -## NodesVersionCompatibility.kibanaVersion property - -Signature: - -```typescript -kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md deleted file mode 100644 index a282bf4b7b4b6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) - -## NodesVersionCompatibility interface - -Signature: - -```typescript -export interface NodesVersionCompatibility -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [incompatibleNodes](./kibana-plugin-core-server.nodesversioncompatibility.incompatiblenodes.md) | NodeInfo\[\] | | -| [isCompatible](./kibana-plugin-core-server.nodesversioncompatibility.iscompatible.md) | boolean | | -| [kibanaVersion](./kibana-plugin-core-server.nodesversioncompatibility.kibanaversion.md) | string | | -| [message?](./kibana-plugin-core-server.nodesversioncompatibility.message.md) | string | (Optional) | -| [nodesInfoRequestError?](./kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md) | Error | (Optional) | -| [warningNodes](./kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md) | NodeInfo\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md deleted file mode 100644 index 415a7825ee2bf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [message](./kibana-plugin-core-server.nodesversioncompatibility.message.md) - -## NodesVersionCompatibility.message property - -Signature: - -```typescript -message?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md deleted file mode 100644 index aa9421afed6e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [nodesInfoRequestError](./kibana-plugin-core-server.nodesversioncompatibility.nodesinforequesterror.md) - -## NodesVersionCompatibility.nodesInfoRequestError property - -Signature: - -```typescript -nodesInfoRequestError?: Error; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md b/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md deleted file mode 100644 index 6c017e9fc800c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) > [warningNodes](./kibana-plugin-core-server.nodesversioncompatibility.warningnodes.md) - -## NodesVersionCompatibility.warningNodes property - -Signature: - -```typescript -warningNodes: NodeInfo[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md deleted file mode 100644 index 2bc48928f57c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthHandler](./kibana-plugin-core-server.onpostauthhandler.md) - -## OnPostAuthHandler type - -See [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md). - -Signature: - -```typescript -export declare type OnPostAuthHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPostAuthToolkit) => OnPostAuthResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md deleted file mode 100644 index 069f63fe01b77..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) - -## OnPostAuthToolkit interface - -A tool set defining an outcome of OnPostAuth interceptor for incoming request. - -Signature: - -```typescript -export interface OnPostAuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpostauthtoolkit.next.md) | () => OnPostAuthResult | To pass request to the next handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md deleted file mode 100644 index a633942cb030f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpostauthtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) > [next](./kibana-plugin-core-server.onpostauthtoolkit.next.md) - -## OnPostAuthToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPostAuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md deleted file mode 100644 index b2997a29f6826..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthHandler](./kibana-plugin-core-server.onpreauthhandler.md) - -## OnPreAuthHandler type - -See [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md). - -Signature: - -```typescript -export declare type OnPreAuthHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPreAuthToolkit) => OnPreAuthResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md deleted file mode 100644 index 44eed5818c610..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) - -## OnPreAuthToolkit interface - -A tool set defining an outcome of OnPreAuth interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreAuthToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreauthtoolkit.next.md) | () => OnPreAuthResult | To pass request to the next handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md deleted file mode 100644 index 96776b374cb84..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreauthtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) > [next](./kibana-plugin-core-server.onpreauthtoolkit.next.md) - -## OnPreAuthToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPreAuthResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md deleted file mode 100644 index f05976b029f9d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) > [headers](./kibana-plugin-core-server.onpreresponseextensions.headers.md) - -## OnPreResponseExtensions.headers property - -additional headers to attach to the response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md deleted file mode 100644 index 078ccc38a70c1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseextensions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseExtensions](./kibana-plugin-core-server.onpreresponseextensions.md) - -## OnPreResponseExtensions interface - -Additional data to extend a response. - -Signature: - -```typescript -export interface OnPreResponseExtensions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers?](./kibana-plugin-core-server.onpreresponseextensions.headers.md) | ResponseHeaders | (Optional) additional headers to attach to the response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md deleted file mode 100644 index 10696fb79a2f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsehandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseHandler](./kibana-plugin-core-server.onpreresponsehandler.md) - -## OnPreResponseHandler type - -See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). - -Signature: - -```typescript -export declare type OnPreResponseHandler = (request: KibanaRequest, preResponse: OnPreResponseInfo, toolkit: OnPreResponseToolkit) => OnPreResponseResult | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md deleted file mode 100644 index 60f7f39ed30a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) - -## OnPreResponseInfo interface - -Response status code. - -Signature: - -```typescript -export interface OnPreResponseInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [statusCode](./kibana-plugin-core-server.onpreresponseinfo.statuscode.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md deleted file mode 100644 index fb2ced48e8961..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponseinfo.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseInfo](./kibana-plugin-core-server.onpreresponseinfo.md) > [statusCode](./kibana-plugin-core-server.onpreresponseinfo.statuscode.md) - -## OnPreResponseInfo.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md deleted file mode 100644 index ab5b5e7a4f272..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) > [body](./kibana-plugin-core-server.onpreresponserender.body.md) - -## OnPreResponseRender.body property - -the body to use in the response - -Signature: - -```typescript -body: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md deleted file mode 100644 index 100d12f63d165..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.headers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) > [headers](./kibana-plugin-core-server.onpreresponserender.headers.md) - -## OnPreResponseRender.headers property - -additional headers to attach to the response - -Signature: - -```typescript -headers?: ResponseHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md deleted file mode 100644 index a5afa1a709326..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponserender.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseRender](./kibana-plugin-core-server.onpreresponserender.md) - -## OnPreResponseRender interface - -Additional data to extend a response when rendering a new body - -Signature: - -```typescript -export interface OnPreResponseRender -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body](./kibana-plugin-core-server.onpreresponserender.body.md) | string | the body to use in the response | -| [headers?](./kibana-plugin-core-server.onpreresponserender.headers.md) | ResponseHeaders | (Optional) additional headers to attach to the response | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md deleted file mode 100644 index 197b7b692e734..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) - -## OnPreResponseToolkit interface - -A tool set defining an outcome of OnPreResponse interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreResponseToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreresponsetoolkit.next.md) | (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult | To pass request to the next handler | -| [render](./kibana-plugin-core-server.onpreresponsetoolkit.render.md) | (responseRender: OnPreResponseRender) => OnPreResponseResult | To override the response with a different body | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md deleted file mode 100644 index 236c3f9bb7419..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) > [next](./kibana-plugin-core-server.onpreresponsetoolkit.next.md) - -## OnPreResponseToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md b/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md deleted file mode 100644 index 7dced7fe8deee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreresponsetoolkit.render.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreResponseToolkit](./kibana-plugin-core-server.onpreresponsetoolkit.md) > [render](./kibana-plugin-core-server.onpreresponsetoolkit.render.md) - -## OnPreResponseToolkit.render property - -To override the response with a different body - -Signature: - -```typescript -render: (responseRender: OnPreResponseRender) => OnPreResponseResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md deleted file mode 100644 index 46016bcd5476a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutinghandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingHandler](./kibana-plugin-core-server.onpreroutinghandler.md) - -## OnPreRoutingHandler type - -See [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md). - -Signature: - -```typescript -export declare type OnPreRoutingHandler = (request: KibanaRequest, response: LifecycleResponseFactory, toolkit: OnPreRoutingToolkit) => OnPreRoutingResult | KibanaResponse | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md deleted file mode 100644 index e3bdeb3c451c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) - -## OnPreRoutingToolkit interface - -A tool set defining an outcome of OnPreRouting interceptor for incoming request. - -Signature: - -```typescript -export interface OnPreRoutingToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [next](./kibana-plugin-core-server.onpreroutingtoolkit.next.md) | () => OnPreRoutingResult | To pass request to the next handler | -| [rewriteUrl](./kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md) | (url: string) => OnPreRoutingResult | Rewrite requested resources url before is was authenticated and routed to a handler | - diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md deleted file mode 100644 index 7fb0b2ce67ba5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.next.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) > [next](./kibana-plugin-core-server.onpreroutingtoolkit.next.md) - -## OnPreRoutingToolkit.next property - -To pass request to the next handler - -Signature: - -```typescript -next: () => OnPreRoutingResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md b/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md deleted file mode 100644 index 346a12711c723..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OnPreRoutingToolkit](./kibana-plugin-core-server.onpreroutingtoolkit.md) > [rewriteUrl](./kibana-plugin-core-server.onpreroutingtoolkit.rewriteurl.md) - -## OnPreRoutingToolkit.rewriteUrl property - -Rewrite requested resources url before is was authenticated and routed to a handler - -Signature: - -```typescript -rewriteUrl: (url: string) => OnPreRoutingResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md deleted file mode 100644 index 25125569b7b38..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.collected_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) - -## OpsMetrics.collected\_at property - -Time metrics were recorded at. - -Signature: - -```typescript -collected_at: Date; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md deleted file mode 100644 index 18d1dc7d13ece..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.concurrent_connections.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) - -## OpsMetrics.concurrent\_connections property - -number of current concurrent connections to the server - -Signature: - -```typescript -concurrent_connections: OpsServerMetrics['concurrent_connections']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md deleted file mode 100644 index dcecfd35a8d2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) - -## OpsMetrics interface - -Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server. - -Signature: - -```typescript -export interface OpsMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) | Date | Time metrics were recorded at. | -| [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) | OpsServerMetrics\['concurrent\_connections'\] | number of current concurrent connections to the server | -| [os](./kibana-plugin-core-server.opsmetrics.os.md) | OpsOsMetrics | OS related metrics | -| [process](./kibana-plugin-core-server.opsmetrics.process.md) | OpsProcessMetrics | Process related metrics. | -| [processes](./kibana-plugin-core-server.opsmetrics.processes.md) | OpsProcessMetrics\[\] | Process related metrics. Reports an array of objects for each kibana pid. | -| [requests](./kibana-plugin-core-server.opsmetrics.requests.md) | OpsServerMetrics\['requests'\] | server requests stats | -| [response\_times](./kibana-plugin-core-server.opsmetrics.response_times.md) | OpsServerMetrics\['response\_times'\] | server response time stats | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md deleted file mode 100644 index a893c847f48be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.os.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [os](./kibana-plugin-core-server.opsmetrics.os.md) - -## OpsMetrics.os property - -OS related metrics - -Signature: - -```typescript -os: OpsOsMetrics; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md deleted file mode 100644 index fa91e8b295b6e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.process.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [process](./kibana-plugin-core-server.opsmetrics.process.md) - -## OpsMetrics.process property - -> Warning: This API is now obsolete. -> -> use the processes field instead. 8.8.0 -> - -Process related metrics. - -Signature: - -```typescript -process: OpsProcessMetrics; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md deleted file mode 100644 index cf1f0a7c54475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.processes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [processes](./kibana-plugin-core-server.opsmetrics.processes.md) - -## OpsMetrics.processes property - -Process related metrics. Reports an array of objects for each kibana pid. - -Signature: - -```typescript -processes: OpsProcessMetrics[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md deleted file mode 100644 index 36d0f445fa8b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.requests.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [requests](./kibana-plugin-core-server.opsmetrics.requests.md) - -## OpsMetrics.requests property - -server requests stats - -Signature: - -```typescript -requests: OpsServerMetrics['requests']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md b/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md deleted file mode 100644 index 6eeef7f607615..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsmetrics.response_times.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) > [response\_times](./kibana-plugin-core-server.opsmetrics.response_times.md) - -## OpsMetrics.response\_times property - -server response time stats - -Signature: - -```typescript -response_times: OpsServerMetrics['response_times']; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md deleted file mode 100644 index 095c45266a251..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpu.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md) - -## OpsOsMetrics.cpu property - -cpu cgroup metrics, undefined when not running in a cgroup - -Signature: - -```typescript -cpu?: { - control_group: string; - cfs_period_micros: number; - cfs_quota_micros: number; - stat: { - number_of_elapsed_periods: number; - number_of_times_throttled: number; - time_throttled_nanos: number; - }; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md deleted file mode 100644 index 140646a0d1a35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.cpuacct.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) - -## OpsOsMetrics.cpuacct property - -cpu accounting metrics, undefined when not running in a cgroup - -Signature: - -```typescript -cpuacct?: { - control_group: string; - usage_nanos: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md deleted file mode 100644 index ef0f46cc220c4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distro.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [distro](./kibana-plugin-core-server.opsosmetrics.distro.md) - -## OpsOsMetrics.distro property - -The os distrib. Only present for linux platforms - -Signature: - -```typescript -distro?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md deleted file mode 100644 index 88bf59888a55e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.distrorelease.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [distroRelease](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) - -## OpsOsMetrics.distroRelease property - -The os distrib release, prefixed by the os distrib. Only present for linux platforms - -Signature: - -```typescript -distroRelease?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md deleted file mode 100644 index 060086cc26def..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.load.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [load](./kibana-plugin-core-server.opsosmetrics.load.md) - -## OpsOsMetrics.load property - -cpu load metrics - -Signature: - -```typescript -load: { - '1m': number; - '5m': number; - '15m': number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md deleted file mode 100644 index 08f205d48dd09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) - -## OpsOsMetrics interface - -OS related metrics - -Signature: - -```typescript -export interface OpsOsMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [cpu?](./kibana-plugin-core-server.opsosmetrics.cpu.md) | { control\_group: string; cfs\_period\_micros: number; cfs\_quota\_micros: number; stat: { number\_of\_elapsed\_periods: number; number\_of\_times\_throttled: number; time\_throttled\_nanos: number; }; } | (Optional) cpu cgroup metrics, undefined when not running in a cgroup | -| [cpuacct?](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) | { control\_group: string; usage\_nanos: number; } | (Optional) cpu accounting metrics, undefined when not running in a cgroup | -| [distro?](./kibana-plugin-core-server.opsosmetrics.distro.md) | string | (Optional) The os distrib. Only present for linux platforms | -| [distroRelease?](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) | string | (Optional) The os distrib release, prefixed by the os distrib. Only present for linux platforms | -| [load](./kibana-plugin-core-server.opsosmetrics.load.md) | { '1m': number; '5m': number; '15m': number; } | cpu load metrics | -| [memory](./kibana-plugin-core-server.opsosmetrics.memory.md) | { total\_in\_bytes: number; free\_in\_bytes: number; used\_in\_bytes: number; } | system memory usage metrics | -| [platform](./kibana-plugin-core-server.opsosmetrics.platform.md) | NodeJS.Platform | The os platform | -| [platformRelease](./kibana-plugin-core-server.opsosmetrics.platformrelease.md) | string | The os platform release, prefixed by the platform name | -| [uptime\_in\_millis](./kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md) | number | the OS uptime | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md deleted file mode 100644 index 10ff674cbda87..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.memory.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [memory](./kibana-plugin-core-server.opsosmetrics.memory.md) - -## OpsOsMetrics.memory property - -system memory usage metrics - -Signature: - -```typescript -memory: { - total_in_bytes: number; - free_in_bytes: number; - used_in_bytes: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md deleted file mode 100644 index 0f4bbf81e2514..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platform.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [platform](./kibana-plugin-core-server.opsosmetrics.platform.md) - -## OpsOsMetrics.platform property - -The os platform - -Signature: - -```typescript -platform: NodeJS.Platform; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md deleted file mode 100644 index b82898ddda632..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.platformrelease.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [platformRelease](./kibana-plugin-core-server.opsosmetrics.platformrelease.md) - -## OpsOsMetrics.platformRelease property - -The os platform release, prefixed by the platform name - -Signature: - -```typescript -platformRelease: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md deleted file mode 100644 index fcae35f02cb80..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) > [uptime\_in\_millis](./kibana-plugin-core-server.opsosmetrics.uptime_in_millis.md) - -## OpsOsMetrics.uptime\_in\_millis property - -the OS uptime - -Signature: - -```typescript -uptime_in_millis: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md deleted file mode 100644 index d626b9cf8f98c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [event\_loop\_delay](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md) - -## OpsProcessMetrics.event\_loop\_delay property - -mean event loop delay since last collection - -Signature: - -```typescript -event_loop_delay: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md deleted file mode 100644 index 1d870b19f2d1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [event\_loop\_delay\_histogram](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md) - -## OpsProcessMetrics.event\_loop\_delay\_histogram property - -node event loop delay histogram since last collection - -Signature: - -```typescript -event_loop_delay_histogram: IntervalHistogram; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md deleted file mode 100644 index 43a4333d7bd2c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) - -## OpsProcessMetrics interface - -Process related metrics - -Signature: - -```typescript -export interface OpsProcessMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event\_loop\_delay\_histogram](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay_histogram.md) | IntervalHistogram | node event loop delay histogram since last collection | -| [event\_loop\_delay](./kibana-plugin-core-server.opsprocessmetrics.event_loop_delay.md) | number | mean event loop delay since last collection | -| [memory](./kibana-plugin-core-server.opsprocessmetrics.memory.md) | { heap: { total\_in\_bytes: number; used\_in\_bytes: number; size\_limit: number; }; resident\_set\_size\_in\_bytes: number; } | process memory usage | -| [pid](./kibana-plugin-core-server.opsprocessmetrics.pid.md) | number | pid of the kibana process | -| [uptime\_in\_millis](./kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md) | number | uptime of the kibana process | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md deleted file mode 100644 index 3bb4aee9f27d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.memory.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [memory](./kibana-plugin-core-server.opsprocessmetrics.memory.md) - -## OpsProcessMetrics.memory property - -process memory usage - -Signature: - -```typescript -memory: { - heap: { - total_in_bytes: number; - used_in_bytes: number; - size_limit: number; - }; - resident_set_size_in_bytes: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md deleted file mode 100644 index a324d758d08cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.pid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [pid](./kibana-plugin-core-server.opsprocessmetrics.pid.md) - -## OpsProcessMetrics.pid property - -pid of the kibana process - -Signature: - -```typescript -pid: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md deleted file mode 100644 index 9879ce44bce1e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsProcessMetrics](./kibana-plugin-core-server.opsprocessmetrics.md) > [uptime\_in\_millis](./kibana-plugin-core-server.opsprocessmetrics.uptime_in_millis.md) - -## OpsProcessMetrics.uptime\_in\_millis property - -uptime of the kibana process - -Signature: - -```typescript -uptime_in_millis: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md deleted file mode 100644 index 30fdee9b958e4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.concurrent_connections.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [concurrent\_connections](./kibana-plugin-core-server.opsservermetrics.concurrent_connections.md) - -## OpsServerMetrics.concurrent\_connections property - -number of current concurrent connections to the server - -Signature: - -```typescript -concurrent_connections: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md deleted file mode 100644 index ddabbd124627b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) - -## OpsServerMetrics interface - -server related metrics - -Signature: - -```typescript -export interface OpsServerMetrics -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [concurrent\_connections](./kibana-plugin-core-server.opsservermetrics.concurrent_connections.md) | number | number of current concurrent connections to the server | -| [requests](./kibana-plugin-core-server.opsservermetrics.requests.md) | { disconnects: number; total: number; statusCodes: Record<number, number>; } | server requests stats | -| [response\_times](./kibana-plugin-core-server.opsservermetrics.response_times.md) | { avg\_in\_millis: number; max\_in\_millis: number; } | server response time stats | - diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md deleted file mode 100644 index 7439b1017e72c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.requests.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [requests](./kibana-plugin-core-server.opsservermetrics.requests.md) - -## OpsServerMetrics.requests property - -server requests stats - -Signature: - -```typescript -requests: { - disconnects: number; - total: number; - statusCodes: Record; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md b/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md deleted file mode 100644 index be66b0b1c1c79..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.opsservermetrics.response_times.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [OpsServerMetrics](./kibana-plugin-core-server.opsservermetrics.md) > [response\_times](./kibana-plugin-core-server.opsservermetrics.response_times.md) - -## OpsServerMetrics.response\_times property - -server response time stats - -Signature: - -```typescript -response_times: { - avg_in_millis: number; - max_in_millis: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.md deleted file mode 100644 index 79dbbb56c86fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) - -## Plugin\_2 interface - -The interface that should be returned by a `PluginInitializer` for a `standard` plugin. - -Signature: - -```typescript -export interface Plugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.plugin_2.setup.md) | | -| [start(core, plugins)](./kibana-plugin-core-server.plugin_2.start.md) | | -| [stop()?](./kibana-plugin-core-server.plugin_2.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md deleted file mode 100644 index cedce40b58000..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [setup](./kibana-plugin-core-server.plugin_2.setup.md) - -## Plugin\_2.setup() method - -Signature: - -```typescript -setup(core: CoreSetup, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreSetup | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md deleted file mode 100644 index 08eb5431a2cf2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.start.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [start](./kibana-plugin-core-server.plugin_2.start.md) - -## Plugin\_2.start() method - -Signature: - -```typescript -start(core: CoreStart, plugins: TPluginsStart): TStart; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CoreStart | | -| plugins | TPluginsStart | | - -Returns: - -TStart - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md b/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md deleted file mode 100644 index 5b62a5e82b2ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugin_2.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Plugin\_2](./kibana-plugin-core-server.plugin_2.md) > [stop](./kibana-plugin-core-server.plugin_2.stop.md) - -## Plugin\_2.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md deleted file mode 100644 index d06b3cb9fa64a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [deprecations](./kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md) - -## PluginConfigDescriptor.deprecations property - -Provider for the to apply to the plugin configuration. - -Signature: - -```typescript -deprecations?: ConfigDeprecationProvider; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md deleted file mode 100644 index 212a0d1c9a26b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [exposeToBrowser](./kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md) - -## PluginConfigDescriptor.exposeToBrowser property - -List of configuration properties that will be available on the client-side plugin. - -Signature: - -```typescript -exposeToBrowser?: ExposedToBrowserDescriptor; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md deleted file mode 100644 index 8c50c2e339426..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [exposeToUsage](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md) - -## PluginConfigDescriptor.exposeToUsage property - -Expose non-default configs to usage collection to be sent via telemetry. set a config to `true` to report the actual changed config value. set a config to `false` to report the changed config value as \[redacted\]. - -All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified. - -[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) - -Signature: - -```typescript -exposeToUsage?: MakeUsageFromSchema; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md deleted file mode 100644 index f5d18c9f40f4d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.md +++ /dev/null @@ -1,50 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) - -## PluginConfigDescriptor interface - -Describes a plugin configuration properties. - -Signature: - -```typescript -export interface PluginConfigDescriptor -``` - -## Example - - -```typescript -// my_plugin/server/index.ts -import { schema, TypeOf } from '@kbn/config-schema'; -import { PluginConfigDescriptor } from 'kibana/server'; - -const configSchema = schema.object({ - secret: schema.string({ defaultValue: 'Only on server' }), - uiProp: schema.string({ defaultValue: 'Accessible from client' }), -}); - -type ConfigType = TypeOf; - -export const config: PluginConfigDescriptor = { - exposeToBrowser: { - uiProp: true, - }, - schema: configSchema, - deprecations: ({ rename, unused }) => [ - rename('securityKey', 'secret'), - unused('deprecatedProperty'), - ], -}; -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [deprecations?](./kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md) | ConfigDeprecationProvider | (Optional) Provider for the to apply to the plugin configuration. | -| [exposeToBrowser?](./kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md) | ExposedToBrowserDescriptor<T> | (Optional) List of configuration properties that will be available on the client-side plugin. | -| [exposeToUsage?](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md) | MakeUsageFromSchema<T> | (Optional) Expose non-default configs to usage collection to be sent via telemetry. set a config to true to report the actual changed config value. set a config to false to report the changed config value as \[redacted\].All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified.[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) | -| [schema](./kibana-plugin-core-server.pluginconfigdescriptor.schema.md) | PluginConfigSchema<T> | Schema to use to validate the plugin configuration.[PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md deleted file mode 100644 index 700b311d941a8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigdescriptor.schema.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) > [schema](./kibana-plugin-core-server.pluginconfigdescriptor.schema.md) - -## PluginConfigDescriptor.schema property - -Schema to use to validate the plugin configuration. - -[PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) - -Signature: - -```typescript -schema: PluginConfigSchema; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md b/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md deleted file mode 100644 index 6f4c60975b48c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginconfigschema.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) - -## PluginConfigSchema type - -Dedicated type for plugin configuration schema. - -Signature: - -```typescript -export declare type PluginConfigSchema = Type; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md deleted file mode 100644 index 9b4d1b022db2a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializer](./kibana-plugin-core-server.plugininitializer.md) - -## PluginInitializer type - -The `plugin` export at the root of a plugin's `server` directory should conform to this interface. - -Signature: - -```typescript -export declare type PluginInitializer = (core: PluginInitializerContext) => Plugin | PrebootPlugin | AsyncPlugin; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md deleted file mode 100644 index 3b5754eb4fa39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.config.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [config](./kibana-plugin-core-server.plugininitializercontext.config.md) - -## PluginInitializerContext.config property - -Accessors for the plugin's configuration - -Signature: - -```typescript -config: { - legacy: { - globalConfig$: Observable; - get: () => SharedGlobalConfig; - }; - create: () => Observable; - get: () => T; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md deleted file mode 100644 index 534f532850587..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.env.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [env](./kibana-plugin-core-server.plugininitializercontext.env.md) - -## PluginInitializerContext.env property - -Signature: - -```typescript -env: { - mode: EnvironmentMode; - packageInfo: Readonly; - instanceUuid: string; - configs: readonly string[]; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md deleted file mode 100644 index 74bf5b0c1384c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.logger.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [logger](./kibana-plugin-core-server.plugininitializercontext.logger.md) - -## PluginInitializerContext.logger property - - instance already bound to the plugin's logging context - -Signature: - -```typescript -logger: LoggerFactory; -``` - -## Example - - -```typescript -// plugins/my-plugin/server/plugin.ts -// "id: myPlugin" in `plugins/my-plugin/kibana.yaml` - -export class MyPlugin implements Plugin { - constructor(private readonly initContext: PluginInitializerContext) { - this.logger = initContext.logger.get(); - // `logger` context: `plugins.myPlugin` - this.mySubLogger = initContext.logger.get('sub'); // or this.logger.get('sub'); - // `mySubLogger` context: `plugins.myPlugin.sub` - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md deleted file mode 100644 index e2d115578d7c1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) - -## PluginInitializerContext interface - -Context that's available to plugins during initialization stage. - -Signature: - -```typescript -export interface PluginInitializerContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [config](./kibana-plugin-core-server.plugininitializercontext.config.md) | { legacy: { globalConfig$: Observable<SharedGlobalConfig>; get: () => SharedGlobalConfig; }; create: <T = ConfigSchema>() => Observable<T>; get: <T = ConfigSchema>() => T; } | Accessors for the plugin's configuration | -| [env](./kibana-plugin-core-server.plugininitializercontext.env.md) | { mode: EnvironmentMode; packageInfo: Readonly<PackageInfo>; instanceUuid: string; configs: readonly string\[\]; } | | -| [logger](./kibana-plugin-core-server.plugininitializercontext.logger.md) | LoggerFactory | instance already bound to the plugin's logging context | -| [opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) | PluginOpaqueId | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md b/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md deleted file mode 100644 index 6e2ef10114687..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.plugininitializercontext.opaqueid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginInitializerContext](./kibana-plugin-core-server.plugininitializercontext.md) > [opaqueId](./kibana-plugin-core-server.plugininitializercontext.opaqueid.md) - -## PluginInitializerContext.opaqueId property - -Signature: - -```typescript -opaqueId: PluginOpaqueId; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md deleted file mode 100644 index 8aa603242df8e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.configpath.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [configPath](./kibana-plugin-core-server.pluginmanifest.configpath.md) - -## PluginManifest.configPath property - -Root used by the plugin, defaults to "id" in snake\_case format. - -Signature: - -```typescript -readonly configPath: ConfigPath; -``` - -## Example - -id: myPlugin configPath: my\_plugin - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md deleted file mode 100644 index b6bba3b5e356c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [description](./kibana-plugin-core-server.pluginmanifest.description.md) - -## PluginManifest.description property - -TODO: make required once all plugins specify this. A brief description of what this plugin does and any capabilities it provides. - -Signature: - -```typescript -readonly description?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md deleted file mode 100644 index 359e84c67cac2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [enabledOnAnonymousPages](./kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md) - -## PluginManifest.enabledOnAnonymousPages property - -Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. - -Signature: - -```typescript -readonly enabledOnAnonymousPages?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md deleted file mode 100644 index fc1b3a800720d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [extraPublicDirs](./kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md) - -## PluginManifest.extraPublicDirs property - -> Warning: This API is now obsolete. -> -> To be deleted when https://github.com/elastic/kibana/issues/101948 is done. -> - -Specifies directory names that can be imported by other ui-plugins built using the same instance of the @kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins - -Signature: - -```typescript -readonly extraPublicDirs?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md deleted file mode 100644 index 7a846f99c0bbb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [id](./kibana-plugin-core-server.pluginmanifest.id.md) - -## PluginManifest.id property - -Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. - -Signature: - -```typescript -readonly id: PluginName; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md deleted file mode 100644 index 822e280172138..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.kibanaversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [kibanaVersion](./kibana-plugin-core-server.pluginmanifest.kibanaversion.md) - -## PluginManifest.kibanaVersion property - -The version of Kibana the plugin is compatible with, defaults to "version". - -Signature: - -```typescript -readonly kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md deleted file mode 100644 index eb3ba06c311c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) - -## PluginManifest interface - -Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. - -Signature: - -```typescript -export interface PluginManifest -``` - -## Remarks - -Should never be used in code outside of Core but is exported for documentation purposes. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [configPath](./kibana-plugin-core-server.pluginmanifest.configpath.md) | ConfigPath | Root used by the plugin, defaults to "id" in snake\_case format. | -| [description?](./kibana-plugin-core-server.pluginmanifest.description.md) | string | (Optional) TODO: make required once all plugins specify this. A brief description of what this plugin does and any capabilities it provides. | -| [enabledOnAnonymousPages?](./kibana-plugin-core-server.pluginmanifest.enabledonanonymouspages.md) | boolean | (Optional) Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. | -| [extraPublicDirs?](./kibana-plugin-core-server.pluginmanifest.extrapublicdirs.md) | string\[\] | (Optional) Specifies directory names that can be imported by other ui-plugins built using the same instance of the @kbn/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins | -| [id](./kibana-plugin-core-server.pluginmanifest.id.md) | PluginName | Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. | -| [kibanaVersion](./kibana-plugin-core-server.pluginmanifest.kibanaversion.md) | string | The version of Kibana the plugin is compatible with, defaults to "version". | -| [optionalPlugins](./kibana-plugin-core-server.pluginmanifest.optionalplugins.md) | readonly PluginName\[\] | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. | -| [owner](./kibana-plugin-core-server.pluginmanifest.owner.md) | { readonly name: string; readonly githubTeam?: string; } | | -| [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) | readonly string\[\] | List of plugin ids that this plugin's UI code imports modules from that are not in requiredPlugins. | -| [requiredPlugins](./kibana-plugin-core-server.pluginmanifest.requiredplugins.md) | readonly PluginName\[\] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. | -| [server](./kibana-plugin-core-server.pluginmanifest.server.md) | boolean | Specifies whether plugin includes some server-side specific functionality. | -| [serviceFolders?](./kibana-plugin-core-server.pluginmanifest.servicefolders.md) | readonly string\[\] | (Optional) Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections. | -| [type](./kibana-plugin-core-server.pluginmanifest.type.md) | PluginType | Type of the plugin, defaults to standard. | -| [ui](./kibana-plugin-core-server.pluginmanifest.ui.md) | boolean | Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via public/ui_plugin.js file. | -| [version](./kibana-plugin-core-server.pluginmanifest.version.md) | string | Version of the plugin. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md deleted file mode 100644 index 5b75b559dfb7e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.optionalplugins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [optionalPlugins](./kibana-plugin-core-server.pluginmanifest.optionalplugins.md) - -## PluginManifest.optionalPlugins property - -An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. - -Signature: - -```typescript -readonly optionalPlugins: readonly PluginName[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md deleted file mode 100644 index 06b97a0313de5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.owner.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [owner](./kibana-plugin-core-server.pluginmanifest.owner.md) - -## PluginManifest.owner property - -Signature: - -```typescript -readonly owner: { - readonly name: string; - readonly githubTeam?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md deleted file mode 100644 index 98505d07101fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) - -## PluginManifest.requiredBundles property - -List of plugin ids that this plugin's UI code imports modules from that are not in `requiredPlugins`. - -Signature: - -```typescript -readonly requiredBundles: readonly string[]; -``` - -## Remarks - -The plugins listed here will be loaded in the browser, even if the plugin is disabled. Required by `@kbn/optimizer` to support cross-plugin imports. "core" and plugins already listed in `requiredPlugins` do not need to be duplicated here. - diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md deleted file mode 100644 index 6cab4b537261b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredplugins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [requiredPlugins](./kibana-plugin-core-server.pluginmanifest.requiredplugins.md) - -## PluginManifest.requiredPlugins property - -An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. - -Signature: - -```typescript -readonly requiredPlugins: readonly PluginName[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md deleted file mode 100644 index 823871bdb1435..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.server.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [server](./kibana-plugin-core-server.pluginmanifest.server.md) - -## PluginManifest.server property - -Specifies whether plugin includes some server-side specific functionality. - -Signature: - -```typescript -readonly server: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md deleted file mode 100644 index 8ee33bdfa0f3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [serviceFolders](./kibana-plugin-core-server.pluginmanifest.servicefolders.md) - -## PluginManifest.serviceFolders property - -Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections. - -Signature: - -```typescript -readonly serviceFolders?: readonly string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md deleted file mode 100644 index 6e82132919f6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [type](./kibana-plugin-core-server.pluginmanifest.type.md) - -## PluginManifest.type property - -Type of the plugin, defaults to `standard`. - -Signature: - -```typescript -readonly type: PluginType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md deleted file mode 100644 index c3fa5009b94f8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.ui.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [ui](./kibana-plugin-core-server.pluginmanifest.ui.md) - -## PluginManifest.ui property - -Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via `public/ui_plugin.js` file. - -Signature: - -```typescript -readonly ui: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md deleted file mode 100644 index 1cd6051a59a10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [version](./kibana-plugin-core-server.pluginmanifest.version.md) - -## PluginManifest.version property - -Version of the plugin. - -Signature: - -```typescript -readonly version: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md deleted file mode 100644 index 78094c5556f31..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversion.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [pollEsNodesVersion](./kibana-plugin-core-server.pollesnodesversion.md) - -## pollEsNodesVersion variable - - -Signature: - -```typescript -pollEsNodesVersion: ({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: PollEsNodesVersionOptions) => Observable -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md deleted file mode 100644 index 74ad0abb0ed4f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [esVersionCheckInterval](./kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md) - -## PollEsNodesVersionOptions.esVersionCheckInterval property - -Signature: - -```typescript -esVersionCheckInterval: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md deleted file mode 100644 index 5ec1c7e527814..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [ignoreVersionMismatch](./kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md) - -## PollEsNodesVersionOptions.ignoreVersionMismatch property - -Signature: - -```typescript -ignoreVersionMismatch: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md deleted file mode 100644 index 50880bc510dfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [internalClient](./kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md) - -## PollEsNodesVersionOptions.internalClient property - -Signature: - -```typescript -internalClient: ElasticsearchClient; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md deleted file mode 100644 index 4a4d25ec606d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [kibanaVersion](./kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md) - -## PollEsNodesVersionOptions.kibanaVersion property - -Signature: - -```typescript -kibanaVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md deleted file mode 100644 index 180b6ee91953b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.log.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) > [log](./kibana-plugin-core-server.pollesnodesversionoptions.log.md) - -## PollEsNodesVersionOptions.log property - -Signature: - -```typescript -log: Logger; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md b/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md deleted file mode 100644 index 130898889c66a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.pollesnodesversionoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PollEsNodesVersionOptions](./kibana-plugin-core-server.pollesnodesversionoptions.md) - -## PollEsNodesVersionOptions interface - - -Signature: - -```typescript -export interface PollEsNodesVersionOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [esVersionCheckInterval](./kibana-plugin-core-server.pollesnodesversionoptions.esversioncheckinterval.md) | number | | -| [ignoreVersionMismatch](./kibana-plugin-core-server.pollesnodesversionoptions.ignoreversionmismatch.md) | boolean | | -| [internalClient](./kibana-plugin-core-server.pollesnodesversionoptions.internalclient.md) | ElasticsearchClient | | -| [kibanaVersion](./kibana-plugin-core-server.pollesnodesversionoptions.kibanaversion.md) | string | | -| [log](./kibana-plugin-core-server.pollesnodesversionoptions.log.md) | Logger | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md deleted file mode 100644 index 8bbb042965dde..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) - -## PrebootPlugin interface - -The interface that should be returned by a `PluginInitializer` for a `preboot` plugin. - -Signature: - -```typescript -export interface PrebootPlugin -``` - -## Methods - -| Method | Description | -| --- | --- | -| [setup(core, plugins)](./kibana-plugin-core-server.prebootplugin.setup.md) | | -| [stop()?](./kibana-plugin-core-server.prebootplugin.stop.md) | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md deleted file mode 100644 index f55819eeaca57..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.setup.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [setup](./kibana-plugin-core-server.prebootplugin.setup.md) - -## PrebootPlugin.setup() method - -Signature: - -```typescript -setup(core: CorePreboot, plugins: TPluginsSetup): TSetup; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | CorePreboot | | -| plugins | TPluginsSetup | | - -Returns: - -TSetup - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md b/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md deleted file mode 100644 index c93dcb7709a11..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootplugin.stop.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) > [stop](./kibana-plugin-core-server.prebootplugin.stop.md) - -## PrebootPlugin.stop() method - -Signature: - -```typescript -stop?(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md deleted file mode 100644 index 7f158b46d1f06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) > [holdSetupUntilResolved](./kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md) - -## PrebootServicePreboot.holdSetupUntilResolved property - -Registers a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple times and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises` instances are resolved, or it will shut down if any of them is rejected. - -Signature: - -```typescript -readonly holdSetupUntilResolved: (reason: string, promise: Promise<{ - shouldReloadConfig: boolean; - } | undefined>) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md deleted file mode 100644 index 1ba079da03208..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) > [isSetupOnHold](./kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md) - -## PrebootServicePreboot.isSetupOnHold property - -Indicates whether Kibana is currently on hold and cannot proceed to `setup` yet. - -Signature: - -```typescript -readonly isSetupOnHold: () => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md b/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md deleted file mode 100644 index c9c7c15ac3275..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.prebootservicepreboot.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) - -## PrebootServicePreboot interface - -Kibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met. - -Signature: - -```typescript -export interface PrebootServicePreboot -``` - -## Example - -A plugin can supply a `Promise` to a `holdSetupUntilResolved` method to signal Kibana to initialize and start `standard` plugins only after this `Promise` is resolved. If `Promise` is rejected, Kibana will shut down. - -```ts -core.preboot.holdSetupUntilResolved('Just waiting for 5 seconds', - new Promise((resolve) => { - setTimeout(resolve, 5000); - }) -); -``` -If the supplied `Promise` resolves to an object with the `shouldReloadConfig` property set to `true`, Kibana will also reload its configuration from disk. - -```ts -let completeSetup: (result: { shouldReloadConfig: boolean }) => void; -core.preboot.holdSetupUntilResolved('Just waiting for 5 seconds before reloading configuration', - new Promise<{ shouldReloadConfig: boolean }>((resolve) => { - setTimeout(() => resolve({ shouldReloadConfig: true }), 5000); - }) -); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [holdSetupUntilResolved](./kibana-plugin-core-server.prebootservicepreboot.holdsetupuntilresolved.md) | (reason: string, promise: Promise<{ shouldReloadConfig: boolean; } \| undefined>) => void | Registers a Promise as a precondition before Kibana can proceed to setup. This method can be invoked multiple times and from multiple preboot plugins. Kibana will proceed to setup only when all registered Promises instances are resolved, or it will shut down if any of them is rejected. | -| [isSetupOnHold](./kibana-plugin-core-server.prebootservicepreboot.issetuponhold.md) | () => boolean | Indicates whether Kibana is currently on hold and cannot proceed to setup yet. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md deleted file mode 100644 index 4ccc91fbe1f74..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.publicuisettingsparams.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PublicUiSettingsParams](./kibana-plugin-core-server.publicuisettingsparams.md) - -## PublicUiSettingsParams type - -A sub-set of [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) exposed to the client-side. - -Signature: - -```typescript -export declare type PublicUiSettingsParams = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md b/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md deleted file mode 100644 index cd5c326c1b9ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.redirectresponseoptions.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RedirectResponseOptions](./kibana-plugin-core-server.redirectresponseoptions.md) - -## RedirectResponseOptions type - -HTTP response parameters for redirection response - -Signature: - -```typescript -export declare type RedirectResponseOptions = HttpResponseOptions & { - headers: { - location: string; - }; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md b/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md deleted file mode 100644 index cf008725ff15b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) > [getDeprecations](./kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md) - -## RegisterDeprecationsConfig.getDeprecations property - -Signature: - -```typescript -getDeprecations: (context: GetDeprecationsContext) => MaybePromise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md b/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md deleted file mode 100644 index b7787a1406319..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.registerdeprecationsconfig.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) - -## RegisterDeprecationsConfig interface - - -Signature: - -```typescript -export interface RegisterDeprecationsConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [getDeprecations](./kibana-plugin-core-server.registerdeprecationsconfig.getdeprecations.md) | (context: GetDeprecationsContext) => MaybePromise<DeprecationsDetails\[\]> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md b/docs/development/core/server/kibana-plugin-core-server.requesthandler.md deleted file mode 100644 index 0ba0f72d7ab2f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandler.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandler](./kibana-plugin-core-server.requesthandler.md) - -## RequestHandler type - -A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) functions. If anything else is returned, or an error is thrown, the HTTP service will automatically log the error and respond `500 - Internal Server Error`. - -Signature: - -```typescript -export declare type RequestHandler

= (context: Context, request: KibanaRequest, response: ResponseFactory) => IKibanaResponse | Promise>; -``` - -## Example - - -```ts -const router = httpSetup.createRouter(); -// creates a route handler for GET request on 'my-app/path/{id}' path -router.get( - { - path: 'path/{id}', - // defines a validation schema for a named segment of the route path - validate: { - params: schema.object({ - id: schema.string(), - }), - }, - }, - // function to execute to create a responses - async (context, request, response) => { - const data = await context.findObject(request.params.id); - // creates a command to respond with 'not found' error - if (!data) return response.notFound(); - // creates a command to send found data to the client - return response.ok(data); - } -); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md deleted file mode 100644 index 8d0b715fdef7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) > [core](./kibana-plugin-core-server.requesthandlercontext.core.md) - -## RequestHandlerContext.core property - -Signature: - -```typescript -core: Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md deleted file mode 100644 index 214f8a6f6ba5c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) - -## RequestHandlerContext interface - -Base context passed to a route handler. - -Signature: - -```typescript -export interface RequestHandlerContext extends RequestHandlerContextBase -``` -Extends: RequestHandlerContextBase - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | Promise<CoreRequestHandlerContext> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md deleted file mode 100644 index 33a123eefae63..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) - -## RequestHandlerContextBase interface - -\* - -Signature: - -```typescript -export interface RequestHandlerContextBase -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md) | <T extends keyof Omit<this, 'resolve'>>(parts: T\[\]) => Promise<AwaitedProperties<Pick<this, T>>> | Await all the specified context parts and return them. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md deleted file mode 100644 index 74192c0e1aee8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) > [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md) - -## RequestHandlerContextBase.resolve property - -Await all the specified context parts and return them. - -Signature: - -```typescript -resolve: >(parts: T[]) => Promise>>; -``` - -## Example - - -```ts -const resolved = await context.resolve(['core', 'pluginA']); -const esClient = resolved.core.elasticsearch.client; -const pluginAService = resolved.pluginA.someService; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md deleted file mode 100644 index 09e7ff261b795..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextcontainer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextContainer](./kibana-plugin-core-server.requesthandlercontextcontainer.md) - -## RequestHandlerContextContainer type - -An object that handles registration of http request context providers. - -Signature: - -```typescript -export declare type RequestHandlerContextContainer = IContextContainer; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md deleted file mode 100644 index d94facd849eff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontextprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerContextProvider](./kibana-plugin-core-server.requesthandlercontextprovider.md) - -## RequestHandlerContextProvider type - -Context provider for request handler. Extends request context object with provided functionality or data. - -Signature: - -```typescript -export declare type RequestHandlerContextProvider = IContextProvider; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md deleted file mode 100644 index 6ae585b4eeb04..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.requesthandlerwrapper.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RequestHandlerWrapper](./kibana-plugin-core-server.requesthandlerwrapper.md) - -## RequestHandlerWrapper type - -Type-safe wrapper for [RequestHandler](./kibana-plugin-core-server.requesthandler.md) function. - -Signature: - -```typescript -export declare type RequestHandlerWrapper = (handler: RequestHandler) => RequestHandler; -``` - -## Example - - -```typescript -export const wrapper: RequestHandlerWrapper = handler => { - return async (context, request, response) => { - // do some logic - ... - }; -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md b/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md deleted file mode 100644 index e23d07d7683de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) - -## ResolveCapabilitiesOptions interface - -Defines a set of additional options for the `resolveCapabilities` method of [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md). - -Signature: - -```typescript -export interface ResolveCapabilitiesOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [useDefaultCapabilities](./kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md) | boolean | Indicates if capability switchers are supposed to return a default set of capabilities. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md b/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md deleted file mode 100644 index 792893a3fc096..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) > [useDefaultCapabilities](./kibana-plugin-core-server.resolvecapabilitiesoptions.usedefaultcapabilities.md) - -## ResolveCapabilitiesOptions.useDefaultCapabilities property - -Indicates if capability switchers are supposed to return a default set of capabilities. - -Signature: - -```typescript -useDefaultCapabilities: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseerror.md b/docs/development/core/server/kibana-plugin-core-server.responseerror.md deleted file mode 100644 index 2d37fa841f273..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseerror.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseError](./kibana-plugin-core-server.responseerror.md) - -## ResponseError type - -Error message and optional data send to the client in case of error. - -Signature: - -```typescript -export declare type ResponseError = string | Error | { - message: string | Error; - attributes?: ResponseErrorAttributes; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md b/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md deleted file mode 100644 index cc85b05f7154e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseerrorattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseErrorAttributes](./kibana-plugin-core-server.responseerrorattributes.md) - -## ResponseErrorAttributes type - -Additional data to provide error details. - -Signature: - -```typescript -export declare type ResponseErrorAttributes = Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md b/docs/development/core/server/kibana-plugin-core-server.responseheaders.md deleted file mode 100644 index fb7d6a10c6b6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.responseheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ResponseHeaders](./kibana-plugin-core-server.responseheaders.md) - -## ResponseHeaders type - -Http response headers to set. - -Signature: - -```typescript -export declare type ResponseHeaders = Record | Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.md deleted file mode 100644 index 6297e2745cd31..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) - -## RouteConfig interface - -Route specific configuration. - -Signature: - -```typescript -export interface RouteConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [options?](./kibana-plugin-core-server.routeconfig.options.md) | RouteConfigOptions<Method> | (Optional) Additional route options [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md). | -| [path](./kibana-plugin-core-server.routeconfig.path.md) | string | The endpoint \_within\_ the router path to register the route. | -| [validate](./kibana-plugin-core-server.routeconfig.validate.md) | RouteValidatorFullConfig<P, Q, B> \| false | A schema created with @kbn/config-schema that every request will be validated against. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md deleted file mode 100644 index 668e293e71827..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [options](./kibana-plugin-core-server.routeconfig.options.md) - -## RouteConfig.options property - -Additional route options [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md). - -Signature: - -```typescript -options?: RouteConfigOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md deleted file mode 100644 index 6d173322442a1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.path.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [path](./kibana-plugin-core-server.routeconfig.path.md) - -## RouteConfig.path property - -The endpoint \_within\_ the router path to register the route. - -Signature: - -```typescript -path: string; -``` - -## Remarks - -E.g. if the router is registered at `/elasticsearch` and the route path is `/search`, the full path for the route is `/elasticsearch/search`. Supports: - named path segments `path/{name}`. - optional path segments `path/{position?}`. - multi-segments `path/{coordinates*2}`. Segments are accessible within a handler function as `params` property of [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md) object. To have read access to `params` you \*must\* specify validation schema with [RouteConfig.validate](./kibana-plugin-core-server.routeconfig.validate.md). - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md b/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md deleted file mode 100644 index 1f9cc216cad35..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfig.validate.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfig](./kibana-plugin-core-server.routeconfig.md) > [validate](./kibana-plugin-core-server.routeconfig.validate.md) - -## RouteConfig.validate property - -A schema created with `@kbn/config-schema` that every request will be validated against. - -Signature: - -```typescript -validate: RouteValidatorFullConfig | false; -``` - -## Remarks - -You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify `validate: false`. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the `@kbn/config-schema` library to output \*\*non-validated values\*\* with setting schema as `schema.object({}, { unknowns: 'allow' })`; - -## Example - - -```ts - import { schema } from '@kbn/config-schema'; - router.get({ - path: 'path/{id}', - validate: { - params: schema.object({ - id: schema.string(), - }), - query: schema.object({...}), - body: schema.object({...}), - }, -}, -(context, req, res,) { - req.params; // type Readonly<{id: string}> - console.log(req.params.id); // value -}); - -router.get({ - path: 'path/{id}', - validate: false, // handler has no access to params, query, body values. -}, -(context, req, res,) { - req.params; // type Readonly<{}>; - console.log(req.params.id); // undefined -}); - -router.get({ - path: 'path/{id}', - validate: { - // handler has access to raw non-validated params in runtime - params: schema.object({}, { unknowns: 'allow' }) - }, -}, -(context, req, res,) { - req.params; // type Readonly<{}>; - console.log(req.params.id); // value - myValidationLibrary.validate({ params: req.params }); -}); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md deleted file mode 100644 index 28f712316bc36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.authrequired.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [authRequired](./kibana-plugin-core-server.routeconfigoptions.authrequired.md) - -## RouteConfigOptions.authRequired property - -Defines authentication mode for a route: - true. A user has to have valid credentials to access a resource - false. A user can access a resource without any credentials. - 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. Can be useful when we grant access to a resource but want to identify a user if possible. - -Defaults to `true` if an auth mechanism is registered. - -Signature: - -```typescript -authRequired?: boolean | 'optional'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md deleted file mode 100644 index a243eb1d91d5b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [body](./kibana-plugin-core-server.routeconfigoptions.body.md) - -## RouteConfigOptions.body property - -Additional body options [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md). - -Signature: - -```typescript -body?: Method extends 'get' | 'options' ? undefined : RouteConfigOptionsBody; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md deleted file mode 100644 index 2dcd8ee5420ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) - -## RouteConfigOptions interface - -Additional route options. - -Signature: - -```typescript -export interface RouteConfigOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authRequired?](./kibana-plugin-core-server.routeconfigoptions.authrequired.md) | boolean \| 'optional' | (Optional) Defines authentication mode for a route: - true. A user has to have valid credentials to access a resource - false. A user can access a resource without any credentials. - 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. Can be useful when we grant access to a resource but want to identify a user if possible.Defaults to true if an auth mechanism is registered. | -| [body?](./kibana-plugin-core-server.routeconfigoptions.body.md) | Method extends 'get' \| 'options' ? undefined : RouteConfigOptionsBody | (Optional) Additional body options [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md). | -| [tags?](./kibana-plugin-core-server.routeconfigoptions.tags.md) | readonly string\[\] | (Optional) Additional metadata tag strings to attach to the route. | -| [timeout?](./kibana-plugin-core-server.routeconfigoptions.timeout.md) | { payload?: Method extends 'get' \| 'options' ? undefined : number; idleSocket?: number; } | (Optional) Defines per-route timeouts. | -| [xsrfRequired?](./kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md) | Method extends 'get' ? never : boolean | (Optional) Defines xsrf protection requirements for a route: - true. Requires an incoming POST/PUT/DELETE request to contain kbn-xsrf header. - false. Disables xsrf protection.Set to true by default | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md deleted file mode 100644 index f279a414d021f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.tags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [tags](./kibana-plugin-core-server.routeconfigoptions.tags.md) - -## RouteConfigOptions.tags property - -Additional metadata tag strings to attach to the route. - -Signature: - -```typescript -tags?: readonly string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md deleted file mode 100644 index f602a8913964f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.timeout.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [timeout](./kibana-plugin-core-server.routeconfigoptions.timeout.md) - -## RouteConfigOptions.timeout property - -Defines per-route timeouts. - -Signature: - -```typescript -timeout?: { - payload?: Method extends 'get' | 'options' ? undefined : number; - idleSocket?: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md deleted file mode 100644 index 1b6a43332e87f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) > [xsrfRequired](./kibana-plugin-core-server.routeconfigoptions.xsrfrequired.md) - -## RouteConfigOptions.xsrfRequired property - -Defines xsrf protection requirements for a route: - true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header. - false. Disables xsrf protection. - -Set to true by default - -Signature: - -```typescript -xsrfRequired?: Method extends 'get' ? never : boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md deleted file mode 100644 index 1e98e33cec00f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.accepts.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [accepts](./kibana-plugin-core-server.routeconfigoptionsbody.accepts.md) - -## RouteConfigOptionsBody.accepts property - -A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed above will not enable them to be parsed, and if parse is true, the request will result in an error response. - -Default value: allows parsing of the following mime types: \* application/json \* application/\*+json \* application/octet-stream \* application/x-www-form-urlencoded \* multipart/form-data \* text/\* - -Signature: - -```typescript -accepts?: RouteContentType | RouteContentType[] | string | string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md deleted file mode 100644 index 4d2641255adb4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [maxBytes](./kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md) - -## RouteConfigOptionsBody.maxBytes property - -Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. - -Default value: The one set in the kibana.yml config file under the parameter `server.maxPayload`. - -Signature: - -```typescript -maxBytes?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md deleted file mode 100644 index fdae03f7cd7c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) - -## RouteConfigOptionsBody interface - -Additional body options for a route - -Signature: - -```typescript -export interface RouteConfigOptionsBody -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [accepts?](./kibana-plugin-core-server.routeconfigoptionsbody.accepts.md) | RouteContentType \| RouteContentType\[\] \| string \| string\[\] | (Optional) A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed above will not enable them to be parsed, and if parse is true, the request will result in an error response.Default value: allows parsing of the following mime types: \* application/json \* application/\*+json \* application/octet-stream \* application/x-www-form-urlencoded \* multipart/form-data \* text/\* | -| [maxBytes?](./kibana-plugin-core-server.routeconfigoptionsbody.maxbytes.md) | number | (Optional) Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.Default value: The one set in the kibana.yml config file under the parameter server.maxPayload. | -| [output?](./kibana-plugin-core-server.routeconfigoptionsbody.output.md) | typeof validBodyOutput\[number\] | (Optional) The processed payload format. The value must be one of: \* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw Buffer is returned. \* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the multipart payload in the handler using a streaming parser (e.g. pez).Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. | -| [parse?](./kibana-plugin-core-server.routeconfigoptionsbody.parse.md) | boolean \| 'gunzip' | (Optional) Determines if the incoming payload is processed or presented raw. Available values: \* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. \* false - the raw payload is returned unmodified. \* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md deleted file mode 100644 index a7d712a39e808..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.output.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [output](./kibana-plugin-core-server.routeconfigoptionsbody.output.md) - -## RouteConfigOptionsBody.output property - -The processed payload format. The value must be one of: \* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw Buffer is returned. \* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the multipart payload in the handler using a streaming parser (e.g. pez). - -Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. - -Signature: - -```typescript -output?: typeof validBodyOutput[number]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md b/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md deleted file mode 100644 index 80c8d470598e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeconfigoptionsbody.parse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteConfigOptionsBody](./kibana-plugin-core-server.routeconfigoptionsbody.md) > [parse](./kibana-plugin-core-server.routeconfigoptionsbody.parse.md) - -## RouteConfigOptionsBody.parse property - -Determines if the incoming payload is processed or presented raw. Available values: \* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. \* false - the raw payload is returned unmodified. \* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. - -Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. - -Signature: - -```typescript -parse?: boolean | 'gunzip'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md b/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md deleted file mode 100644 index 8d8b041f3c722..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routecontenttype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteContentType](./kibana-plugin-core-server.routecontenttype.md) - -## RouteContentType type - -The set of supported parseable Content-Types - -Signature: - -```typescript -export declare type RouteContentType = 'application/json' | 'application/*+json' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/*'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routemethod.md b/docs/development/core/server/kibana-plugin-core-server.routemethod.md deleted file mode 100644 index 297ed5ce25cee..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteMethod](./kibana-plugin-core-server.routemethod.md) - -## RouteMethod type - -The set of common HTTP methods supported by Kibana routing. - -Signature: - -```typescript -export declare type RouteMethod = SafeRouteMethod | DestructiveRouteMethod; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md b/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md deleted file mode 100644 index 3ddb350a38b6f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routeregistrar.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteRegistrar](./kibana-plugin-core-server.routeregistrar.md) - -## RouteRegistrar type - -Route handler common definition - -Signature: - -```typescript -export declare type RouteRegistrar = (route: RouteConfig, handler: RequestHandler) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md deleted file mode 100644 index ad1a4bae0dab1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) > [(constructor)](./kibana-plugin-core-server.routevalidationerror._constructor_.md) - -## RouteValidationError.(constructor) - -Constructs a new instance of the `RouteValidationError` class - -Signature: - -```typescript -constructor(error: Error | string, path?: string[]); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| string | | -| path | string\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md deleted file mode 100644 index 60a47236b4be5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationerror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationError](./kibana-plugin-core-server.routevalidationerror.md) - -## RouteValidationError class - -Error to return when the validation is not successful. - -Signature: - -```typescript -export declare class RouteValidationError extends SchemaTypeError -``` -Extends: SchemaTypeError - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(error, path)](./kibana-plugin-core-server.routevalidationerror._constructor_.md) | | Constructs a new instance of the RouteValidationError class | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md deleted file mode 100644 index e3fd33552f7df..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationfunction.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) - -## RouteValidationFunction type - -The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. - -Signature: - -```typescript -export declare type RouteValidationFunction = (data: any, validationResult: RouteValidationResultFactory) => { - value: T; - error?: never; -} | { - value?: never; - error: RouteValidationError; -}; -``` - -## Example - -The validation should look something like: - -```typescript -interface MyExpectedBody { - bar: string; - baz: number; -} - -const myBodyValidation: RouteValidationFunction = (data, validationResult) => { - const { ok, badRequest } = validationResult; - const { bar, baz } = data || {}; - if (typeof bar === 'string' && typeof baz === 'number') { - return ok({ bar, baz }); - } else { - return badRequest('Wrong payload', ['body']); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md deleted file mode 100644 index d02ce47a84d50..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.badrequest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) > [badRequest](./kibana-plugin-core-server.routevalidationresultfactory.badrequest.md) - -## RouteValidationResultFactory.badRequest property - -Signature: - -```typescript -badRequest: (error: Error | string, path?: string[]) => { - error: RouteValidationError; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md deleted file mode 100644 index 69e8b5e73136e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) - -## RouteValidationResultFactory interface - -Validation result factory to be used in the custom validation function to return the valid data or validation errors - -See [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md). - -Signature: - -```typescript -export interface RouteValidationResultFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [badRequest](./kibana-plugin-core-server.routevalidationresultfactory.badrequest.md) | (error: Error \| string, path?: string\[\]) => { error: RouteValidationError; } | | -| [ok](./kibana-plugin-core-server.routevalidationresultfactory.ok.md) | <T>(value: T) => { value: T; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md deleted file mode 100644 index 42e7a055cd021..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationresultfactory.ok.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationResultFactory](./kibana-plugin-core-server.routevalidationresultfactory.md) > [ok](./kibana-plugin-core-server.routevalidationresultfactory.ok.md) - -## RouteValidationResultFactory.ok property - -Signature: - -```typescript -ok: (value: T) => { - value: T; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md b/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md deleted file mode 100644 index 193e047efcfe0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidationspec.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidationSpec](./kibana-plugin-core-server.routevalidationspec.md) - -## RouteValidationSpec type - -Allowed property validation options: either @kbn/config-schema validations or custom validation functions - -See [RouteValidationFunction](./kibana-plugin-core-server.routevalidationfunction.md) for custom validation. - -Signature: - -```typescript -export declare type RouteValidationSpec = ObjectType | Type | RouteValidationFunction; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md deleted file mode 100644 index 922a475b432fa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.body.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [body](./kibana-plugin-core-server.routevalidatorconfig.body.md) - -## RouteValidatorConfig.body property - -Validation logic for the body payload - -Signature: - -```typescript -body?: RouteValidationSpec; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md deleted file mode 100644 index 848bf6aa4b15e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) - -## RouteValidatorConfig interface - -The configuration object to the RouteValidator class. Set `params`, `query` and/or `body` to specify the validation logic to follow for that property. - -Signature: - -```typescript -export interface RouteValidatorConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [body?](./kibana-plugin-core-server.routevalidatorconfig.body.md) | RouteValidationSpec<B> | (Optional) Validation logic for the body payload | -| [params?](./kibana-plugin-core-server.routevalidatorconfig.params.md) | RouteValidationSpec<P> | (Optional) Validation logic for the URL params | -| [query?](./kibana-plugin-core-server.routevalidatorconfig.query.md) | RouteValidationSpec<Q> | (Optional) Validation logic for the Query params | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md deleted file mode 100644 index 1281d4ab78f6f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.params.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [params](./kibana-plugin-core-server.routevalidatorconfig.params.md) - -## RouteValidatorConfig.params property - -Validation logic for the URL params - -Signature: - -```typescript -params?: RouteValidationSpec

; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md deleted file mode 100644 index 9bda00954c02f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorconfig.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorConfig](./kibana-plugin-core-server.routevalidatorconfig.md) > [query](./kibana-plugin-core-server.routevalidatorconfig.query.md) - -## RouteValidatorConfig.query property - -Validation logic for the Query params - -Signature: - -```typescript -query?: RouteValidationSpec; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md deleted file mode 100644 index 4ed91aee6b8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatorfullconfig.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorFullConfig](./kibana-plugin-core-server.routevalidatorfullconfig.md) - -## RouteValidatorFullConfig type - -Route validations config and options merged into one object - -Signature: - -```typescript -export declare type RouteValidatorFullConfig = RouteValidatorConfig & RouteValidatorOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md deleted file mode 100644 index f054ca388762a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) - -## RouteValidatorOptions interface - -Additional options for the RouteValidator class to modify its default behaviour. - -Signature: - -```typescript -export interface RouteValidatorOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [unsafe?](./kibana-plugin-core-server.routevalidatoroptions.unsafe.md) | { params?: boolean; query?: boolean; body?: boolean; } | (Optional) Set the unsafe config to avoid running some additional internal \*safe\* validations on top of your custom validation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md b/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md deleted file mode 100644 index ca66ccbb55a36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.routevalidatoroptions.unsafe.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [RouteValidatorOptions](./kibana-plugin-core-server.routevalidatoroptions.md) > [unsafe](./kibana-plugin-core-server.routevalidatoroptions.unsafe.md) - -## RouteValidatorOptions.unsafe property - -Set the `unsafe` config to avoid running some additional internal \*safe\* validations on top of your custom validation - -Signature: - -```typescript -unsafe?: { - params?: boolean; - query?: boolean; - body?: boolean; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md b/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md deleted file mode 100644 index 93a8d8de358be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.saferoutemethod.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SafeRouteMethod](./kibana-plugin-core-server.saferoutemethod.md) - -## SafeRouteMethod type - -Set of HTTP methods not changing the state of the server. - -Signature: - -```typescript -export declare type SafeRouteMethod = 'get' | 'options'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md deleted file mode 100644 index 3bc0900bb4005..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [attributes](./kibana-plugin-core-server.savedobject.attributes.md) - -## SavedObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md deleted file mode 100644 index b4d1f3c769451..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.coremigrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobject.coremigrationversion.md) - -## SavedObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md deleted file mode 100644 index ef42053e38626..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [error](./kibana-plugin-core-server.savedobject.error.md) - -## SavedObject.error property - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md deleted file mode 100644 index 86adacdc4c41a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [id](./kibana-plugin-core-server.savedobject.id.md) - -## SavedObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.md deleted file mode 100644 index cffb47659dc23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) - -## SavedObject interface - -Signature: - -```typescript -export interface SavedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobject.attributes.md) | T | The data for a Saved Object is stored as an object in the attributes property. | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. | -| [error?](./kibana-plugin-core-server.savedobject.error.md) | SavedObjectError | (Optional) | -| [id](./kibana-plugin-core-server.savedobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [migrationVersion?](./kibana-plugin-core-server.savedobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [namespaces?](./kibana-plugin-core-server.savedobject.namespaces.md) | string\[\] | (Optional) Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with namespaceType: 'agnostic'. | -| [originId?](./kibana-plugin-core-server.savedobject.originid.md) | string | (Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. | -| [references](./kibana-plugin-core-server.savedobject.references.md) | SavedObjectReference\[\] | A reference to another saved object. | -| [type](./kibana-plugin-core-server.savedobject.type.md) | string | The type of Saved Object. Each plugin can define it's own custom Saved Object types. | -| [updated\_at?](./kibana-plugin-core-server.savedobject.updated_at.md) | string | (Optional) Timestamp of the last time this document had been updated. | -| [version?](./kibana-plugin-core-server.savedobject.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md deleted file mode 100644 index 3b3eaa6e5da06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [migrationVersion](./kibana-plugin-core-server.savedobject.migrationversion.md) - -## SavedObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md deleted file mode 100644 index 3c2909486219b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.namespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [namespaces](./kibana-plugin-core-server.savedobject.namespaces.md) - -## SavedObject.namespaces property - -Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with `namespaceType: 'agnostic'`. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md deleted file mode 100644 index 95bcad7ce8b1b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [originId](./kibana-plugin-core-server.savedobject.originid.md) - -## SavedObject.originId property - -The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md deleted file mode 100644 index f8290bd40d217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [references](./kibana-plugin-core-server.savedobject.references.md) - -## SavedObject.references property - -A reference to another saved object. - -Signature: - -```typescript -references: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md deleted file mode 100644 index 6c667b0b9c3a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [type](./kibana-plugin-core-server.savedobject.type.md) - -## SavedObject.type property - -The type of Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md deleted file mode 100644 index a9585761ca808..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.updated_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [updated\_at](./kibana-plugin-core-server.savedobject.updated_at.md) - -## SavedObject.updated\_at property - -Timestamp of the last time this document had been updated. - -Signature: - -```typescript -updated_at?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md deleted file mode 100644 index ef8fd3be86beb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobject.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObject](./kibana-plugin-core-server.savedobject.md) > [version](./kibana-plugin-core-server.savedobject.version.md) - -## SavedObject.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md deleted file mode 100644 index 1a1e3f62d34f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattribute.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) - -## SavedObjectAttribute type - -Type definition for a Saved Object attribute value - -Signature: - -```typescript -export declare type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md deleted file mode 100644 index 2b8b212cd78d6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttributes](./kibana-plugin-core-server.savedobjectattributes.md) - -## SavedObjectAttributes interface - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -export interface SavedObjectAttributes -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md deleted file mode 100644 index 7c84fa5414074..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectattributesingle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectAttributeSingle](./kibana-plugin-core-server.savedobjectattributesingle.md) - -## SavedObjectAttributeSingle type - -Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-core-server.savedobjectattribute.md) - -Signature: - -```typescript -export declare type SavedObjectAttributeSingle = string | number | boolean | null | undefined | SavedObjectAttributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md deleted file mode 100644 index 0972d82987f51..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [excludeExportDetails](./kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md) - -## SavedObjectExportBaseOptions.excludeExportDetails property - -flag to not append [export details](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) to the end of the export stream. - -Signature: - -```typescript -excludeExportDetails?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md deleted file mode 100644 index 8ac532c601efc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [includeNamespaces](./kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md) - -## SavedObjectExportBaseOptions.includeNamespaces property - -Flag to also include namespace information in the export stream. By default, namespace information is not included in exported objects. This is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP route for exports. - -Signature: - -```typescript -includeNamespaces?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md deleted file mode 100644 index 6a7c86c1af860..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [includeReferencesDeep](./kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md) - -## SavedObjectExportBaseOptions.includeReferencesDeep property - -flag to also include all related saved objects in the export stream. - -Signature: - -```typescript -includeReferencesDeep?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md deleted file mode 100644 index d2749cb85cd3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) - -## SavedObjectExportBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectExportBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludeExportDetails?](./kibana-plugin-core-server.savedobjectexportbaseoptions.excludeexportdetails.md) | boolean | (Optional) flag to not append [export details](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) to the end of the export stream. | -| [includeNamespaces?](./kibana-plugin-core-server.savedobjectexportbaseoptions.includenamespaces.md) | boolean | (Optional) Flag to also include namespace information in the export stream. By default, namespace information is not included in exported objects. This is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP route for exports. | -| [includeReferencesDeep?](./kibana-plugin-core-server.savedobjectexportbaseoptions.includereferencesdeep.md) | boolean | (Optional) flag to also include all related saved objects in the export stream. | -| [namespace?](./kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md) | string | (Optional) optional namespace to override the namespace used by the savedObjectsClient. | -| [request](./kibana-plugin-core-server.savedobjectexportbaseoptions.request.md) | KibanaRequest | The http request initiating the export. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md deleted file mode 100644 index 9a8dad24ac18e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectexportbaseoptions.namespace.md) - -## SavedObjectExportBaseOptions.namespace property - -optional namespace to override the namespace used by the savedObjectsClient. - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md deleted file mode 100644 index d425f9b88e818..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectexportbaseoptions.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectExportBaseOptions](./kibana-plugin-core-server.savedobjectexportbaseoptions.md) > [request](./kibana-plugin-core-server.savedobjectexportbaseoptions.request.md) - -## SavedObjectExportBaseOptions.request property - -The http request initiating the export. - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md deleted file mode 100644 index 9fe43a2f3f477..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [convertToMultiNamespaceTypeVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md) - -## SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion property - -The version in which this object type is being converted to a multi-namespace type - -Signature: - -```typescript -readonly convertToMultiNamespaceTypeVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md deleted file mode 100644 index 528be67f029c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [isSingleNamespaceType](./kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md) - -## SavedObjectMigrationContext.isSingleNamespaceType property - -Whether this is a single-namespace type or not - -Signature: - -```typescript -readonly isSingleNamespaceType: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md deleted file mode 100644 index 20a0e99275a39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.log.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [log](./kibana-plugin-core-server.savedobjectmigrationcontext.log.md) - -## SavedObjectMigrationContext.log property - -logger instance to be used by the migration handler - -Signature: - -```typescript -readonly log: SavedObjectsMigrationLogger; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md deleted file mode 100644 index 3a265cc8e1d42..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) - -## SavedObjectMigrationContext interface - -Migration context provided when invoking a [migration handler](./kibana-plugin-core-server.savedobjectmigrationfn.md) - -Signature: - -```typescript -export interface SavedObjectMigrationContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [convertToMultiNamespaceTypeVersion?](./kibana-plugin-core-server.savedobjectmigrationcontext.converttomultinamespacetypeversion.md) | string | (Optional) The version in which this object type is being converted to a multi-namespace type | -| [isSingleNamespaceType](./kibana-plugin-core-server.savedobjectmigrationcontext.issinglenamespacetype.md) | boolean | Whether this is a single-namespace type or not | -| [log](./kibana-plugin-core-server.savedobjectmigrationcontext.log.md) | SavedObjectsMigrationLogger | logger instance to be used by the migration handler | -| [migrationVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md) | string | The migration version that this migration function is defined for | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md deleted file mode 100644 index a1c2717e6e4a0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectmigrationcontext.migrationversion.md) - -## SavedObjectMigrationContext.migrationVersion property - -The migration version that this migration function is defined for - -Signature: - -```typescript -readonly migrationVersion: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md deleted file mode 100644 index 1c96c63a3d4fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationFn](./kibana-plugin-core-server.savedobjectmigrationfn.md) - -## SavedObjectMigrationFn type - -A migration function for a [saved object type](./kibana-plugin-core-server.savedobjectstype.md) used to migrate it to a given version - -Signature: - -```typescript -export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc; -``` - -## Example - - -```typescript -interface TypeV1Attributes { - someKey: string; - obsoleteProperty: number; -} - -interface TypeV2Attributes { - someKey: string; - newProperty: string; -} - -const migrateToV2: SavedObjectMigrationFn = (doc, { log }) => { - const { obsoleteProperty, ...otherAttributes } = doc.attributes; - // instead of mutating `doc` we make a shallow copy so that we can use separate types for the input - // and output attributes. We don't need to make a deep copy, we just need to ensure that obsolete - // attributes are not present on the returned doc. - return { - ...doc, - attributes: { - ...otherAttributes, - newProperty: migrate(obsoleteProperty), - }, - }; -}; -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md deleted file mode 100644 index 64575d34bfb10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationmap.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectMigrationMap](./kibana-plugin-core-server.savedobjectmigrationmap.md) - -## SavedObjectMigrationMap interface - -A map of [migration functions](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions, and they cannot exceed the current Kibana version. - -For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. - -Signature: - -```typescript -export interface SavedObjectMigrationMap -``` - -## Example - - -```typescript -const migrationsMap: SavedObjectMigrationMap = { - '1.0.0': migrateToV1, - '2.1.0': migrateToV21 -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md deleted file mode 100644 index f5f1de451165b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [id](./kibana-plugin-core-server.savedobjectreference.id.md) - -## SavedObjectReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md deleted file mode 100644 index bf21b13acfcfc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) - -## SavedObjectReference interface - -A reference to another saved object. - -Signature: - -```typescript -export interface SavedObjectReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectreference.id.md) | string | | -| [name](./kibana-plugin-core-server.savedobjectreference.name.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectreference.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md deleted file mode 100644 index 782e8060a31f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [name](./kibana-plugin-core-server.savedobjectreference.name.md) - -## SavedObjectReference.name property - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md deleted file mode 100644 index 045a540904279..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md) > [type](./kibana-plugin-core-server.savedobjectreference.type.md) - -## SavedObjectReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md deleted file mode 100644 index 7ef1a2fb1bd41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [id](./kibana-plugin-core-server.savedobjectreferencewithcontext.id.md) - -## SavedObjectReferenceWithContext.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md deleted file mode 100644 index 058c27032d065..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [inboundReferences](./kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md) - -## SavedObjectReferenceWithContext.inboundReferences property - -References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation - -Signature: - -```typescript -inboundReferences: Array<{ - type: string; - id: string; - name: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md deleted file mode 100644 index d46d5a6bf2a0a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [isMissing](./kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md) - -## SavedObjectReferenceWithContext.isMissing property - -Whether or not this object or reference is missing - -Signature: - -```typescript -isMissing?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md deleted file mode 100644 index 79dd7a40019ec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) - -## SavedObjectReferenceWithContext interface - -A returned input object or one of its references, with additional context. - -Signature: - -```typescript -export interface SavedObjectReferenceWithContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectreferencewithcontext.id.md) | string | The ID of the referenced object | -| [inboundReferences](./kibana-plugin-core-server.savedobjectreferencewithcontext.inboundreferences.md) | Array<{ type: string; id: string; name: string; }> | References to this object; note that this does not contain \_all inbound references everywhere for this object\_, it only contains inbound references for the scope of this operation | -| [isMissing?](./kibana-plugin-core-server.savedobjectreferencewithcontext.ismissing.md) | boolean | (Optional) Whether or not this object or reference is missing | -| [originId?](./kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md) | string | (Optional) The origin ID of the referenced object (if it has one) | -| [spaces](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [spacesWithMatchingAliases?](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) | string\[\] | (Optional) The space(s) that legacy URL aliases matching this type/id exist in | -| [spacesWithMatchingOrigins?](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) | string\[\] | (Optional) The space(s) that objects matching this origin exist in (including this one) | -| [type](./kibana-plugin-core-server.savedobjectreferencewithcontext.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md deleted file mode 100644 index 47cac3f423647..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [originId](./kibana-plugin-core-server.savedobjectreferencewithcontext.originid.md) - -## SavedObjectReferenceWithContext.originId property - -The origin ID of the referenced object (if it has one) - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md deleted file mode 100644 index 2c2114103b29a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spaces](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaces.md) - -## SavedObjectReferenceWithContext.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md deleted file mode 100644 index 07f4158a84950..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spacesWithMatchingAliases](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingaliases.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingAliases property - -The space(s) that legacy URL aliases matching this type/id exist in - -Signature: - -```typescript -spacesWithMatchingAliases?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md deleted file mode 100644 index 3fedce753c034..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [spacesWithMatchingOrigins](./kibana-plugin-core-server.savedobjectreferencewithcontext.spaceswithmatchingorigins.md) - -## SavedObjectReferenceWithContext.spacesWithMatchingOrigins property - -The space(s) that objects matching this origin exist in (including this one) - -Signature: - -```typescript -spacesWithMatchingOrigins?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md deleted file mode 100644 index 118d9744e4276..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectreferencewithcontext.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectReferenceWithContext](./kibana-plugin-core-server.savedobjectreferencewithcontext.md) > [type](./kibana-plugin-core-server.savedobjectreferencewithcontext.type.md) - -## SavedObjectReferenceWithContext.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md deleted file mode 100644 index 3f4090619edbf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectSanitizedDoc](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) - -## SavedObjectSanitizedDoc type - -Describes Saved Object documents that have passed through the migration framework and are guaranteed to have a `references` root property. - -Signature: - -```typescript -export declare type SavedObjectSanitizedDoc = SavedObjectDoc & Referencable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md deleted file mode 100644 index 6686ad7ca8bad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) - -## SavedObjectsBaseOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBaseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespace?](./kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md) | string | (Optional) Specify the namespace for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md deleted file mode 100644 index 7468327233d4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsbaseoptions.namespace.md) - -## SavedObjectsBaseOptions.namespace property - -Specify the namespace for this operation - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md deleted file mode 100644 index c74a058ca441b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [attributes](./kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md) - -## SavedObjectsBulkCreateObject.attributes property - -Signature: - -```typescript -attributes: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md deleted file mode 100644 index fb1f485cdf202..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md) - -## SavedObjectsBulkCreateObject.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` - -## Remarks - -Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` field set and you want to create it again. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md deleted file mode 100644 index 13f64c70d39fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md) - -## SavedObjectsBulkCreateObject.id property - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md deleted file mode 100644 index 4d094ecde7a96..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [initialNamespaces](./kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md) - -## SavedObjectsBulkCreateObject.initialNamespaces property - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md). - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -initialNamespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md deleted file mode 100644 index 441df5d50c612..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) - -## SavedObjectsBulkCreateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkCreateObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsbulkcreateobject.attributes.md) | T | | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. | -| [id?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.id.md) | string | (Optional) | -| [initialNamespaces?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.initialnamespaces.md) | string\[\] | (Optional) Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md).\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [originId?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md) | string | (Optional) Optional ID of the original saved object, if this object's id was regenerated | -| [references?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md) | SavedObjectReference\[\] | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md) | string | | -| [version?](./kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md) | string | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md deleted file mode 100644 index a2d8de7c5caaa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectsbulkcreateobject.migrationversion.md) - -## SavedObjectsBulkCreateObject.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md deleted file mode 100644 index c182a47891f62..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [originId](./kibana-plugin-core-server.savedobjectsbulkcreateobject.originid.md) - -## SavedObjectsBulkCreateObject.originId property - -Optional ID of the original saved object, if this object's `id` was regenerated - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md deleted file mode 100644 index d5aed38d7c1e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [references](./kibana-plugin-core-server.savedobjectsbulkcreateobject.references.md) - -## SavedObjectsBulkCreateObject.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md deleted file mode 100644 index 0d9973ec78b4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkcreateobject.type.md) - -## SavedObjectsBulkCreateObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md deleted file mode 100644 index ca2a38693d036..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) > [version](./kibana-plugin-core-server.savedobjectsbulkcreateobject.version.md) - -## SavedObjectsBulkCreateObject.version property - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md deleted file mode 100644 index d20f79101e13d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [fields](./kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md) - -## SavedObjectsBulkGetObject.fields property - -SavedObject fields to include in the response - -Signature: - -```typescript -fields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md deleted file mode 100644 index c9d6b0527bd56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkgetobject.id.md) - -## SavedObjectsBulkGetObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md deleted file mode 100644 index 0eb5b507a1f03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) - -## SavedObjectsBulkGetObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkGetObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fields?](./kibana-plugin-core-server.savedobjectsbulkgetobject.fields.md) | string\[\] | (Optional) SavedObject fields to include in the response | -| [id](./kibana-plugin-core-server.savedobjectsbulkgetobject.id.md) | string | | -| [namespaces?](./kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md) | string\[\] | (Optional) Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the top-level options.\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [type](./kibana-plugin-core-server.savedobjectsbulkgetobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md deleted file mode 100644 index 5add0ad1bdf95..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [namespaces](./kibana-plugin-core-server.savedobjectsbulkgetobject.namespaces.md) - -## SavedObjectsBulkGetObject.namespaces property - -Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the top-level options. - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md deleted file mode 100644 index 9b78423da9d0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkgetobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkgetobject.type.md) - -## SavedObjectsBulkGetObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md deleted file mode 100644 index 135848191cff7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md) - -## SavedObjectsBulkResolveObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md deleted file mode 100644 index a81e18cf3593a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) - -## SavedObjectsBulkResolveObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md deleted file mode 100644 index 790edde7fe079..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md) - -## SavedObjectsBulkResolveObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md deleted file mode 100644 index e280877d77cd6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) - -## SavedObjectsBulkResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [resolved\_objects](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md) | Array<SavedObjectsResolveResponse<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md deleted file mode 100644 index 4d11b146fd848..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md) - -## SavedObjectsBulkResolveResponse.resolved\_objects property - -Signature: - -```typescript -resolved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md deleted file mode 100644 index e47350e4bf888..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) - -## SavedObjectsBulkResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md) | Array<SavedObject<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md deleted file mode 100644 index 3b21276ec2a66..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkresponse.saved_objects.md) - -## SavedObjectsBulkResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md deleted file mode 100644 index 7b8d41c4345af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) - -## SavedObjectsBulkUpdateObject.attributes property - -The data for a Saved Object is stored as an object in the `attributes` property. - -Signature: - -```typescript -attributes: Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md deleted file mode 100644 index 41aa239bbd502..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) - -## SavedObjectsBulkUpdateObject.id property - -The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md deleted file mode 100644 index fa20d5d13d8f2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) - -## SavedObjectsBulkUpdateObject interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateObject extends Pick, 'version' | 'references'> -``` -Extends: Pick<SavedObjectsUpdateOptions<T>, 'version' \| 'references'> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) | Partial<T> | The data for a Saved Object is stored as an object in the attributes property. | -| [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) | string | The ID of this Saved Object, guaranteed to be unique for all objects of the same type | -| [namespace?](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | string | (Optional) Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md).Note: the default namespace's string representation is 'default', and its ID representation is undefined. | -| [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) | string | The type of this Saved Object. Each plugin can define it's own custom Saved Object types. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md deleted file mode 100644 index 544efcd3be909..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) - -## SavedObjectsBulkUpdateObject.namespace property - -Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md). - -Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md deleted file mode 100644 index f13adddc05a09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) - -## SavedObjectsBulkUpdateObject.type property - -The type of this Saved Object. Each plugin can define it's own custom Saved Object types. - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md deleted file mode 100644 index 97285b326dbae..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) - -## SavedObjectsBulkUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md deleted file mode 100644 index 9c1b2145dd0da..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.refresh.md) - -## SavedObjectsBulkUpdateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md deleted file mode 100644 index e1a1af2da25cc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) - -## SavedObjectsBulkUpdateResponse interface - - -Signature: - -```typescript -export interface SavedObjectsBulkUpdateResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md) | Array<SavedObjectsUpdateResponse<T>> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md deleted file mode 100644 index e7cbad9678ca7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkUpdateResponse](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsbulkupdateresponse.saved_objects.md) - -## SavedObjectsBulkUpdateResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md deleted file mode 100644 index 2b7cd5cc486a8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) > [id](./kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md) - -## SavedObjectsCheckConflictsObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md deleted file mode 100644 index af7d9ff74db25..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) - -## SavedObjectsCheckConflictsObject interface - - -Signature: - -```typescript -export interface SavedObjectsCheckConflictsObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectscheckconflictsobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md deleted file mode 100644 index 82f89536e4189..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsObject](./kibana-plugin-core-server.savedobjectscheckconflictsobject.md) > [type](./kibana-plugin-core-server.savedobjectscheckconflictsobject.type.md) - -## SavedObjectsCheckConflictsObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md deleted file mode 100644 index 80bd61d8906e3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) > [errors](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md) - -## SavedObjectsCheckConflictsResponse.errors property - -Signature: - -```typescript -errors: Array<{ - id: string; - type: string; - error: SavedObjectError; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md deleted file mode 100644 index 68bbdbe67c273..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscheckconflictsresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCheckConflictsResponse](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.md) - -## SavedObjectsCheckConflictsResponse interface - - -Signature: - -```typescript -export interface SavedObjectsCheckConflictsResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors](./kibana-plugin-core-server.savedobjectscheckconflictsresponse.errors.md) | Array<{ id: string; type: string; error: SavedObjectError; }> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md deleted file mode 100644 index a88d82ef49e7d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkcreate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkCreate](./kibana-plugin-core-server.savedobjectsclient.bulkcreate.md) - -## SavedObjectsClient.bulkCreate() method - -Persists multiple documents batched together as a single request - -Signature: - -```typescript -bulkCreate(objects: Array>, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkCreateObject<T>> | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md deleted file mode 100644 index 077cb08843acc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkget.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkGet](./kibana-plugin-core-server.savedobjectsclient.bulkget.md) - -## SavedObjectsClient.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkGetObject\[\] | an array of ids, or an array of objects containing id, type and optionally fields | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md deleted file mode 100644 index 3cf6e4d8d76a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkresolve.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkResolve](./kibana-plugin-core-server.savedobjectsclient.bulkresolve.md) - -## SavedObjectsClient.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: SavedObjectsBulkResolveObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkResolveObject\[\] | an array of objects containing id, type | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - - Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior is unique to `bulkResolve`; the regular `resolve` API will throw an error instead. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md deleted file mode 100644 index 6c4034357a4ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.bulkupdate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [bulkUpdate](./kibana-plugin-core-server.savedobjectsclient.bulkupdate.md) - -## SavedObjectsClient.bulkUpdate() method - -Bulk Updates multiple SavedObject at once - -Signature: - -```typescript -bulkUpdate(objects: Array>, options?: SavedObjectsBulkUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkUpdateObject<T>> | | -| options | SavedObjectsBulkUpdateOptions | | - -Returns: - -Promise<SavedObjectsBulkUpdateResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md deleted file mode 100644 index 69d52ee098a30..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.checkconflicts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [checkConflicts](./kibana-plugin-core-server.savedobjectsclient.checkconflicts.md) - -## SavedObjectsClient.checkConflicts() method - -Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. - -Signature: - -```typescript -checkConflicts(objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCheckConflictsObject\[\] | | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsCheckConflictsResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md deleted file mode 100644 index beb5ea847bf45..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.closepointintime.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [closePointInTime](./kibana-plugin-core-server.savedobjectsclient.closepointintime.md) - -## SavedObjectsClient.closePointInTime() method - -Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. - -Signature: - -```typescript -closePointInTime(id: string, options?: SavedObjectsClosePointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | -| options | SavedObjectsClosePointInTimeOptions | | - -Returns: - -Promise<SavedObjectsClosePointInTimeResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md deleted file mode 100644 index 64ccd4187597c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [collectMultiNamespaceReferences](./kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md) - -## SavedObjectsClient.collectMultiNamespaceReferences() method - -Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. - -Signature: - -```typescript -collectMultiNamespaceReferences(objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCollectMultiNamespaceReferencesObject\[\] | | -| options | SavedObjectsCollectMultiNamespaceReferencesOptions | | - -Returns: - -Promise<SavedObjectsCollectMultiNamespaceReferencesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md deleted file mode 100644 index 9f9b72984bbb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.create.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [create](./kibana-plugin-core-server.savedobjectsclient.create.md) - -## SavedObjectsClient.create() method - -Persists a SavedObject - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | | - -Returns: - -Promise<SavedObject<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md deleted file mode 100644 index eab4312b1daa4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [createPointInTimeFinder](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) - -## SavedObjectsClient.createPointInTimeFinder() method - -Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any `find` queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client. - -Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments. - -The generator wraps calls to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage`. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -createPointInTimeFinder(findOptions: SavedObjectsCreatePointInTimeFinderOptions, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies): ISavedObjectsPointInTimeFinder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| findOptions | SavedObjectsCreatePointInTimeFinderOptions | | -| dependencies | SavedObjectsCreatePointInTimeFinderDependencies | | - -Returns: - -ISavedObjectsPointInTimeFinder<T, A> - -## Example - - -```ts -const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - type: 'visualization', - search: 'foo*', - perPage: 100, -}; - -const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - -const responses: SavedObjectFindResponse[] = []; -for await (const response of finder.find()) { - responses.push(...response); - if (doneSearching) { - await finder.close(); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md deleted file mode 100644 index 64ed7778d3bec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.delete.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [delete](./kibana-plugin-core-server.savedobjectsclient.delete.md) - -## SavedObjectsClient.delete() method - -Deletes a SavedObject - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | | - -Returns: - -Promise<{}> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md deleted file mode 100644 index 79219f48d0501..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) - -## SavedObjectsClient.errors property - -Signature: - -```typescript -static errors: typeof SavedObjectsErrorHelpers; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md deleted file mode 100644 index dc48f7481dc01..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.find.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [find](./kibana-plugin-core-server.savedobjectsclient.find.md) - -## SavedObjectsClient.find() method - -Find all SavedObjects matching the search query - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | | - -Returns: - -Promise<SavedObjectsFindResponse<T, A>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md deleted file mode 100644 index 00b6dd28bb7aa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.get.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [get](./kibana-plugin-core-server.savedobjectsclient.get.md) - -## SavedObjectsClient.get() method - -Retrieves a single object - -Signature: - -```typescript -get(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of SavedObject to retrieve | -| id | string | The ID of the SavedObject to retrieve | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObject<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md deleted file mode 100644 index c77bcfac2f0e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) - -## SavedObjectsClient class - -Signature: - -```typescript -export declare class SavedObjectsClient -``` - -## Remarks - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) | | typeof SavedObjectsErrorHelpers | | -| [errors](./kibana-plugin-core-server.savedobjectsclient.errors.md) | static | typeof SavedObjectsErrorHelpers | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkcreate.md) | | Persists multiple documents batched together as a single request | -| [bulkGet(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkget.md) | | Returns an array of objects by id | -| [bulkResolve(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkresolve.md) | | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects, options)](./kibana-plugin-core-server.savedobjectsclient.bulkupdate.md) | | Bulk Updates multiple SavedObject at once | -| [checkConflicts(objects, options)](./kibana-plugin-core-server.savedobjectsclient.checkconflicts.md) | | Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. | -| [closePointInTime(id, options)](./kibana-plugin-core-server.savedobjectsclient.closepointintime.md) | | Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md).Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. | -| [collectMultiNamespaceReferences(objects, options)](./kibana-plugin-core-server.savedobjectsclient.collectmultinamespacereferences.md) | | Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. | -| [create(type, attributes, options)](./kibana-plugin-core-server.savedobjectsclient.create.md) | | Persists a SavedObject | -| [createPointInTimeFinder(findOptions, dependencies)](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) | | Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any find queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client.Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments.The generator wraps calls to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [delete(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.delete.md) | | Deletes a SavedObject | -| [find(options)](./kibana-plugin-core-server.savedobjectsclient.find.md) | | Find all SavedObjects matching the search query | -| [get(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.get.md) | | Retrieves a single object | -| [openPointInTimeForType(type, options)](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md) | | Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned id can then be passed to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) to search against that PIT.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. | -| [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md) | | Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. | -| [resolve(type, id, options)](./kibana-plugin-core-server.savedobjectsclient.resolve.md) | | Resolves a single object, using any legacy URL alias if it exists | -| [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsclient.update.md) | | Updates an SavedObject | -| [updateObjectsSpaces(objects, spacesToAdd, spacesToRemove, options)](./kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md) | | Updates one or more objects to add and/or remove them from specified spaces. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md deleted file mode 100644 index c449fc7b1c3f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [openPointInTimeForType](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md) - -## SavedObjectsClient.openPointInTimeForType() method - -Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned `id` can then be passed to [SavedObjectsClient.find()](./kibana-plugin-core-server.savedobjectsclient.find.md) to search against that PIT. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsClient.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsclient.createpointintimefinder.md) method. - -Signature: - -```typescript -openPointInTimeForType(type: string | string[], options?: SavedObjectsOpenPointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| string\[\] | | -| options | SavedObjectsOpenPointInTimeOptions | | - -Returns: - -Promise<SavedObjectsOpenPointInTimeResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md deleted file mode 100644 index 560c210b0105b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.removereferencesto.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [removeReferencesTo](./kibana-plugin-core-server.savedobjectsclient.removereferencesto.md) - -## SavedObjectsClient.removeReferencesTo() method - -Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - -Signature: - -```typescript -removeReferencesTo(type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsRemoveReferencesToOptions | | - -Returns: - -Promise<SavedObjectsRemoveReferencesToResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md deleted file mode 100644 index 31eabe46d6cb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.resolve.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [resolve](./kibana-plugin-core-server.savedobjectsclient.resolve.md) - -## SavedObjectsClient.resolve() method - -Resolves a single object, using any legacy URL alias if it exists - -Signature: - -```typescript -resolve(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of SavedObject to retrieve | -| id | string | The ID of the SavedObject to retrieve | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsResolveResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md deleted file mode 100644 index 20a67387813ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.update.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [update](./kibana-plugin-core-server.savedobjectsclient.update.md) - -## SavedObjectsClient.update() method - -Updates an SavedObject - -Signature: - -```typescript -update(type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | Partial<T> | | -| options | SavedObjectsUpdateOptions<T> | | - -Returns: - -Promise<SavedObjectsUpdateResponse<T>> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md deleted file mode 100644 index 09012607fd932..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) > [updateObjectsSpaces](./kibana-plugin-core-server.savedobjectsclient.updateobjectsspaces.md) - -## SavedObjectsClient.updateObjectsSpaces() method - -Updates one or more objects to add and/or remove them from specified spaces. - -Signature: - -```typescript -updateObjectsSpaces(objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsUpdateObjectsSpacesObject\[\] | | -| spacesToAdd | string\[\] | | -| spacesToRemove | string\[\] | | -| options | SavedObjectsUpdateObjectsSpacesOptions | | - -Returns: - -Promise<import("./lib").SavedObjectsUpdateObjectsSpacesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md deleted file mode 100644 index f4e7895a3f3eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientcontract.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) - -## SavedObjectsClientContract type - -Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. - -\#\# SavedObjectsClient errors - -Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either: - -1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the `isXYZError()` helpers exposed at `SavedObjectsErrorHelpers` should be used to understand and manage error responses from the `SavedObjectsClient`. - -Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for `error.body.error.type` or doing substring checks on `error.body.error.reason`, just use the helpers to understand the meaning of the error: - -\`\`\`js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 } - -if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know } - -// always rethrow the error unless you handle it throw error; \`\`\` - -\#\#\# 404s from missing index - -From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistence and that index might be missing. - -At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages. - -From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing. - -See [SavedObjectsClient](./kibana-plugin-core-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -Signature: - -```typescript -export declare type SavedObjectsClientContract = Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md deleted file mode 100644 index 724c1ebbeadf4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactory.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md) - -## SavedObjectsClientFactory type - -Describes the factory used to create instances of the Saved Objects Client. - -Signature: - -```typescript -export declare type SavedObjectsClientFactory = ({ request, includedHiddenTypes, }: { - request: KibanaRequest; - includedHiddenTypes?: string[]; -}) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md deleted file mode 100644 index 0b7afda66408f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientfactoryprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) - -## SavedObjectsClientFactoryProvider type - -Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md). - -Signature: - -```typescript -export declare type SavedObjectsClientFactoryProvider = (repositoryFactory: SavedObjectsRepositoryFactory) => SavedObjectsClientFactory; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md deleted file mode 100644 index 1fc74de6699fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) > [excludedWrappers](./kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md) - -## SavedObjectsClientProviderOptions.excludedWrappers property - -Signature: - -```typescript -excludedWrappers?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md deleted file mode 100644 index a9483e34b38ce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) > [includedHiddenTypes](./kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md) - -## SavedObjectsClientProviderOptions.includedHiddenTypes property - -Signature: - -```typescript -includedHiddenTypes?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md deleted file mode 100644 index a02f54214163b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientprovideroptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientProviderOptions](./kibana-plugin-core-server.savedobjectsclientprovideroptions.md) - -## SavedObjectsClientProviderOptions interface - -Options to control the creation of the Saved Objects Client. - -Signature: - -```typescript -export interface SavedObjectsClientProviderOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludedWrappers?](./kibana-plugin-core-server.savedobjectsclientprovideroptions.excludedwrappers.md) | string\[\] | (Optional) | -| [includedHiddenTypes?](./kibana-plugin-core-server.savedobjectsclientprovideroptions.includedhiddentypes.md) | string\[\] | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md deleted file mode 100644 index 722804fd7faa3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperfactory.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) - -## SavedObjectsClientWrapperFactory type - -Describes the factory used to create instances of Saved Objects Client Wrappers. - -Signature: - -```typescript -export declare type SavedObjectsClientWrapperFactory = (options: SavedObjectsClientWrapperOptions) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md deleted file mode 100644 index 1c40647cc8793..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [client](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md) - -## SavedObjectsClientWrapperOptions.client property - -Signature: - -```typescript -client: SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md deleted file mode 100644 index 16d104e4a8dff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) - -## SavedObjectsClientWrapperOptions interface - -Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. - -Signature: - -```typescript -export interface SavedObjectsClientWrapperOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.client.md) | SavedObjectsClientContract | | -| [request](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md) | KibanaRequest | | -| [typeRegistry](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md) | ISavedObjectTypeRegistry | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md deleted file mode 100644 index a76936b44aa73..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [request](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.request.md) - -## SavedObjectsClientWrapperOptions.request property - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md deleted file mode 100644 index 17d23869f6d93..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClientWrapperOptions](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.md) > [typeRegistry](./kibana-plugin-core-server.savedobjectsclientwrapperoptions.typeregistry.md) - -## SavedObjectsClientWrapperOptions.typeRegistry property - -Signature: - -```typescript -typeRegistry: ISavedObjectTypeRegistry; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md deleted file mode 100644 index 27432a8805b06..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) - -## SavedObjectsClosePointInTimeOptions type - - -Signature: - -```typescript -export declare type SavedObjectsClosePointInTimeOptions = SavedObjectsBaseOptions; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md deleted file mode 100644 index 27010232bd46b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) - -## SavedObjectsClosePointInTimeResponse interface - - -Signature: - -```typescript -export interface SavedObjectsClosePointInTimeResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [num\_freed](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md) | number | The number of search contexts that have been successfully closed. | -| [succeeded](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md) | boolean | If true, all search contexts associated with the PIT id are successfully closed. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md deleted file mode 100644 index b64932fcee8f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) > [num\_freed](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.num_freed.md) - -## SavedObjectsClosePointInTimeResponse.num\_freed property - -The number of search contexts that have been successfully closed. - -Signature: - -```typescript -num_freed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md deleted file mode 100644 index 225a549a4cf59..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) > [succeeded](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.succeeded.md) - -## SavedObjectsClosePointInTimeResponse.succeeded property - -If true, all search contexts associated with the PIT id are successfully closed. - -Signature: - -```typescript -succeeded: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md deleted file mode 100644 index 21522a0f32d6d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) > [id](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md deleted file mode 100644 index 5f419a63e8c70..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject interface - -An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the `namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option). - -Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with the `namespaceType: 'multiple'`). - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md deleted file mode 100644 index c376a9e4258c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesObject](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.md) > [type](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesobject.type.md) - -## SavedObjectsCollectMultiNamespaceReferencesObject.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md deleted file mode 100644 index 57298e40a88ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) - -## SavedObjectsCollectMultiNamespaceReferencesOptions interface - -Options for collecting references. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [purpose?](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md) | 'collectMultiNamespaceReferences' \| 'updateObjectsSpaces' | (Optional) Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md deleted file mode 100644 index a36301a6451bc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesOptions](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.md) > [purpose](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesoptions.purpose.md) - -## SavedObjectsCollectMultiNamespaceReferencesOptions.purpose property - -Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' - -Signature: - -```typescript -purpose?: 'collectMultiNamespaceReferences' | 'updateObjectsSpaces'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md deleted file mode 100644 index 514e9271aa17e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse interface - -The response when object references are collected. - -Signature: - -```typescript -export interface SavedObjectsCollectMultiNamespaceReferencesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md) | SavedObjectReferenceWithContext\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md deleted file mode 100644 index 4b5707d7228a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCollectMultiNamespaceReferencesResponse](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.md) > [objects](./kibana-plugin-core-server.savedobjectscollectmultinamespacereferencesresponse.objects.md) - -## SavedObjectsCollectMultiNamespaceReferencesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectReferenceWithContext[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md deleted file mode 100644 index e2a4064ec4f33..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [coreMigrationVersion](./kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md) - -## SavedObjectsCreateOptions.coreMigrationVersion property - -A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. - -Signature: - -```typescript -coreMigrationVersion?: string; -``` - -## Remarks - -Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` field set and you want to create it again. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md deleted file mode 100644 index 85529b54bf2cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [id](./kibana-plugin-core-server.savedobjectscreateoptions.id.md) - -## SavedObjectsCreateOptions.id property - -(not recommended) Specify an id for the document - -Signature: - -```typescript -id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md deleted file mode 100644 index 43489b8d2e8a2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [initialNamespaces](./kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md) - -## SavedObjectsCreateOptions.initialNamespaces property - -Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md). - -\* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, including the "All spaces" identifier (`'*'`). \* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. \* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - -Signature: - -```typescript -initialNamespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md deleted file mode 100644 index 646a0f6fcf548..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) - -## SavedObjectsCreateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [coreMigrationVersion?](./kibana-plugin-core-server.savedobjectscreateoptions.coremigrationversion.md) | string | (Optional) A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the current Kibana version, it will result in an error. | -| [id?](./kibana-plugin-core-server.savedobjectscreateoptions.id.md) | string | (Optional) (not recommended) Specify an id for the document | -| [initialNamespaces?](./kibana-plugin-core-server.savedobjectscreateoptions.initialnamespaces.md) | string\[\] | (Optional) Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md).\* For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). \* For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. \* For global object types (registered with namespaceType: 'agnostic'): this option cannot be used. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. | -| [originId?](./kibana-plugin-core-server.savedobjectscreateoptions.originid.md) | string | (Optional) Optional ID of the original saved object, if this object's id was regenerated | -| [overwrite?](./kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md) | boolean | (Optional) Overwrite existing documents (defaults to false) | -| [references?](./kibana-plugin-core-server.savedobjectscreateoptions.references.md) | SavedObjectReference\[\] | (Optional) | -| [refresh?](./kibana-plugin-core-server.savedobjectscreateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | -| [version?](./kibana-plugin-core-server.savedobjectscreateoptions.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used in conjunction with overwrite for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md deleted file mode 100644 index 6bc66128623b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectscreateoptions.migrationversion.md) - -## SavedObjectsCreateOptions.migrationVersion property - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md deleted file mode 100644 index 14333079f7440..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.originid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [originId](./kibana-plugin-core-server.savedobjectscreateoptions.originid.md) - -## SavedObjectsCreateOptions.originId property - -Optional ID of the original saved object, if this object's `id` was regenerated - -Signature: - -```typescript -originId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md deleted file mode 100644 index 3925cd4ebb2c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [overwrite](./kibana-plugin-core-server.savedobjectscreateoptions.overwrite.md) - -## SavedObjectsCreateOptions.overwrite property - -Overwrite existing documents (defaults to false) - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md deleted file mode 100644 index bbc1c3524694f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [references](./kibana-plugin-core-server.savedobjectscreateoptions.references.md) - -## SavedObjectsCreateOptions.references property - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md deleted file mode 100644 index 69f158a69b504..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectscreateoptions.refresh.md) - -## SavedObjectsCreateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md deleted file mode 100644 index 51da57064abb9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreateoptions.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreateOptions](./kibana-plugin-core-server.savedobjectscreateoptions.md) > [version](./kibana-plugin-core-server.savedobjectscreateoptions.version.md) - -## SavedObjectsCreateOptions.version property - -An opaque version number which changes on each successful write operation. Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md deleted file mode 100644 index 95ab9e225c049..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) > [client](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md) - -## SavedObjectsCreatePointInTimeFinderDependencies.client property - -Signature: - -```typescript -client: Pick; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md deleted file mode 100644 index f647a9c1367b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderDependencies](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.md) - -## SavedObjectsCreatePointInTimeFinderDependencies interface - - -Signature: - -```typescript -export interface SavedObjectsCreatePointInTimeFinderDependencies -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [client](./kibana-plugin-core-server.savedobjectscreatepointintimefinderdependencies.client.md) | Pick<SavedObjectsClientContract, 'find' \| 'openPointInTimeForType' \| 'closePointInTime'> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md deleted file mode 100644 index 928c6f72bcbf5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsCreatePointInTimeFinderOptions](./kibana-plugin-core-server.savedobjectscreatepointintimefinderoptions.md) - -## SavedObjectsCreatePointInTimeFinderOptions type - - -Signature: - -```typescript -export declare type SavedObjectsCreatePointInTimeFinderOptions = Omit; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md deleted file mode 100644 index 49b6c36cf3ed2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) - -## SavedObjectsDeleteByNamespaceOptions interface - - -Signature: - -```typescript -export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) | boolean | (Optional) The Elasticsearch supports only boolean flag for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md deleted file mode 100644 index 52b562e8e22b7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) - -## SavedObjectsDeleteByNamespaceOptions.refresh property - -The Elasticsearch supports only boolean flag for this operation - -Signature: - -```typescript -refresh?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md deleted file mode 100644 index f869d1f863a9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.force.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) > [force](./kibana-plugin-core-server.savedobjectsdeleteoptions.force.md) - -## SavedObjectsDeleteOptions.force property - -Force deletion of an object that exists in multiple namespaces - -Signature: - -```typescript -force?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md deleted file mode 100644 index e1bc1fcec3f2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) - -## SavedObjectsDeleteOptions interface - - -Signature: - -```typescript -export interface SavedObjectsDeleteOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [force?](./kibana-plugin-core-server.savedobjectsdeleteoptions.force.md) | boolean | (Optional) Force deletion of an object that exists in multiple namespaces | -| [refresh?](./kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md deleted file mode 100644 index 3a31b90dd9b7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsDeleteOptions](./kibana-plugin-core-server.savedobjectsdeleteoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsdeleteoptions.refresh.md) - -## SavedObjectsDeleteOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md deleted file mode 100644 index f101aa98d8bd3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) - -## SavedObjectsErrorHelpers.createBadRequestError() method - -Signature: - -```typescript -static createBadRequestError(reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md deleted file mode 100644 index 426de67ded2dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) - -## SavedObjectsErrorHelpers.createConflictError() method - -Signature: - -```typescript -static createConflictError(type: string, id: string, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md deleted file mode 100644 index 6ac403b442367..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createGenericNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) - -## SavedObjectsErrorHelpers.createGenericNotFoundError() method - -Signature: - -```typescript -static createGenericNotFoundError(type?: string | null, id?: string | null): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| null | | -| id | string \| null | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md deleted file mode 100644 index 4892c0e41ab01..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createGenericNotFoundEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) - -## SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError() method - -Signature: - -```typescript -static createGenericNotFoundEsUnavailableError(type?: string | null, id?: string | null): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| null | | -| id | string \| null | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md deleted file mode 100644 index 4f9fa9d4484bd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createIndexAliasNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) - -## SavedObjectsErrorHelpers.createIndexAliasNotFoundError() method - -Signature: - -```typescript -static createIndexAliasNotFoundError(alias: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| alias | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md deleted file mode 100644 index 59e2a65694008..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createInvalidVersionError](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) - -## SavedObjectsErrorHelpers.createInvalidVersionError() method - -Signature: - -```typescript -static createInvalidVersionError(versionInput?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| versionInput | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md deleted file mode 100644 index 3d4903c3482ed..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.createTooManyRequestsError() method - -Signature: - -```typescript -static createTooManyRequestsError(type: string, id: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md deleted file mode 100644 index 4ca95c1565db6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [createUnsupportedTypeError](./kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md) - -## SavedObjectsErrorHelpers.createUnsupportedTypeError() method - -Signature: - -```typescript -static createUnsupportedTypeError(type: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md deleted file mode 100644 index 043950407519f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md) - -## SavedObjectsErrorHelpers.decorateBadRequestError() method - -Signature: - -```typescript -static decorateBadRequestError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md deleted file mode 100644 index dfb981a0a656e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md) - -## SavedObjectsErrorHelpers.decorateConflictError() method - -Signature: - -```typescript -static decorateConflictError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md deleted file mode 100644 index 18b019f1b5364..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateEsCannotExecuteScriptError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md) - -## SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError() method - -Signature: - -```typescript -static decorateEsCannotExecuteScriptError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md deleted file mode 100644 index 9d272b1e78454..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md) - -## SavedObjectsErrorHelpers.decorateEsUnavailableError() method - -Signature: - -```typescript -static decorateEsUnavailableError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md deleted file mode 100644 index 11b53ec219334..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateForbiddenError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md) - -## SavedObjectsErrorHelpers.decorateForbiddenError() method - -Signature: - -```typescript -static decorateForbiddenError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md deleted file mode 100644 index 595789611b5c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateGeneralError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md) - -## SavedObjectsErrorHelpers.decorateGeneralError() method - -Signature: - -```typescript -static decorateGeneralError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md deleted file mode 100644 index a2e74ca7769e0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateIndexAliasNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md) - -## SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError() method - -Signature: - -```typescript -static decorateIndexAliasNotFoundError(error: Error, alias: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| alias | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md deleted file mode 100644 index d50d5d9ebf45f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateNotAuthorizedError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md) - -## SavedObjectsErrorHelpers.decorateNotAuthorizedError() method - -Signature: - -```typescript -static decorateNotAuthorizedError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md deleted file mode 100644 index 487d64f83ca30..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateRequestEntityTooLargeError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md) - -## SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError() method - -Signature: - -```typescript -static decorateRequestEntityTooLargeError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md deleted file mode 100644 index b85cf196c3cdb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [decorateTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.decorateTooManyRequestsError() method - -Signature: - -```typescript -static decorateTooManyRequestsError(error: Error, reason?: string): DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error | | -| reason | string | | - -Returns: - -DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md deleted file mode 100644 index 5dd6a50b61e55..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isBadRequestError](./kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md) - -## SavedObjectsErrorHelpers.isBadRequestError() method - -Signature: - -```typescript -static isBadRequestError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md deleted file mode 100644 index 9762462af9ef3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isConflictError](./kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md) - -## SavedObjectsErrorHelpers.isConflictError() method - -Signature: - -```typescript -static isConflictError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md deleted file mode 100644 index e007dd30f2bb0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isEsCannotExecuteScriptError](./kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md) - -## SavedObjectsErrorHelpers.isEsCannotExecuteScriptError() method - -Signature: - -```typescript -static isEsCannotExecuteScriptError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md deleted file mode 100644 index a6fb911f5e0eb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isEsUnavailableError](./kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md) - -## SavedObjectsErrorHelpers.isEsUnavailableError() method - -Signature: - -```typescript -static isEsUnavailableError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md deleted file mode 100644 index e45ef7a7ed3f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isForbiddenError](./kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md) - -## SavedObjectsErrorHelpers.isForbiddenError() method - -Signature: - -```typescript -static isForbiddenError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md deleted file mode 100644 index cbec5d3b36a80..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isGeneralError](./kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md) - -## SavedObjectsErrorHelpers.isGeneralError() method - -Signature: - -```typescript -static isGeneralError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md deleted file mode 100644 index 8ad480147adf6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isInvalidVersionError](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) - -## SavedObjectsErrorHelpers.isInvalidVersionError() method - -Signature: - -```typescript -static isInvalidVersionError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md deleted file mode 100644 index 5e85718bde511..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isNotAuthorizedError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) - -## SavedObjectsErrorHelpers.isNotAuthorizedError() method - -Signature: - -```typescript -static isNotAuthorizedError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md deleted file mode 100644 index 05e848322ae9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isNotFoundError](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) - -## SavedObjectsErrorHelpers.isNotFoundError() method - -Signature: - -```typescript -static isNotFoundError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md deleted file mode 100644 index d6674f0a588e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isRequestEntityTooLargeError](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) - -## SavedObjectsErrorHelpers.isRequestEntityTooLargeError() method - -Signature: - -```typescript -static isRequestEntityTooLargeError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md deleted file mode 100644 index 0505c3a450a32..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isSavedObjectsClientError](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) - -## SavedObjectsErrorHelpers.isSavedObjectsClientError() method - -Signature: - -```typescript -static isSavedObjectsClientError(error: any): error is DecoratedError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | any | | - -Returns: - -error is DecoratedError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md deleted file mode 100644 index 3f9c360710ae3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) > [isTooManyRequestsError](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) - -## SavedObjectsErrorHelpers.isTooManyRequestsError() method - -Signature: - -```typescript -static isTooManyRequestsError(error: Error | DecoratedError): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| error | Error \| DecoratedError | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md deleted file mode 100644 index 67056c8a3cb50..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectserrorhelpers.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) - -## SavedObjectsErrorHelpers class - - -Signature: - -```typescript -export declare class SavedObjectsErrorHelpers -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [createBadRequestError(reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createbadrequesterror.md) | static | | -| [createConflictError(type, id, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.createconflicterror.md) | static | | -| [createGenericNotFoundError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfounderror.md) | static | | -| [createGenericNotFoundEsUnavailableError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.creategenericnotfoundesunavailableerror.md) | static | | -| [createIndexAliasNotFoundError(alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.createindexaliasnotfounderror.md) | static | | -| [createInvalidVersionError(versionInput)](./kibana-plugin-core-server.savedobjectserrorhelpers.createinvalidversionerror.md) | static | | -| [createTooManyRequestsError(type, id)](./kibana-plugin-core-server.savedobjectserrorhelpers.createtoomanyrequestserror.md) | static | | -| [createUnsupportedTypeError(type)](./kibana-plugin-core-server.savedobjectserrorhelpers.createunsupportedtypeerror.md) | static | | -| [decorateBadRequestError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratebadrequesterror.md) | static | | -| [decorateConflictError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateconflicterror.md) | static | | -| [decorateEsCannotExecuteScriptError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateescannotexecutescripterror.md) | static | | -| [decorateEsUnavailableError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateesunavailableerror.md) | static | | -| [decorateForbiddenError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateforbiddenerror.md) | static | | -| [decorateGeneralError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorategeneralerror.md) | static | | -| [decorateIndexAliasNotFoundError(error, alias)](./kibana-plugin-core-server.savedobjectserrorhelpers.decorateindexaliasnotfounderror.md) | static | | -| [decorateNotAuthorizedError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratenotauthorizederror.md) | static | | -| [decorateRequestEntityTooLargeError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoraterequestentitytoolargeerror.md) | static | | -| [decorateTooManyRequestsError(error, reason)](./kibana-plugin-core-server.savedobjectserrorhelpers.decoratetoomanyrequestserror.md) | static | | -| [isBadRequestError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isbadrequesterror.md) | static | | -| [isConflictError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isconflicterror.md) | static | | -| [isEsCannotExecuteScriptError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isescannotexecutescripterror.md) | static | | -| [isEsUnavailableError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isesunavailableerror.md) | static | | -| [isForbiddenError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isforbiddenerror.md) | static | | -| [isGeneralError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isgeneralerror.md) | static | | -| [isInvalidVersionError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isinvalidversionerror.md) | static | | -| [isNotAuthorizedError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotauthorizederror.md) | static | | -| [isNotFoundError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isnotfounderror.md) | static | | -| [isRequestEntityTooLargeError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.isrequestentitytoolargeerror.md) | static | | -| [isSavedObjectsClientError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.issavedobjectsclienterror.md) | static | | -| [isTooManyRequestsError(error)](./kibana-plugin-core-server.savedobjectserrorhelpers.istoomanyrequestserror.md) | static | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md deleted file mode 100644 index 4d3154bb2f7ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) - -## SavedObjectsExportByObjectOptions interface - -Options for the [export by objects API](./kibana-plugin-core-server.isavedobjectsexporter.exportbyobjects.md) - -Signature: - -```typescript -export interface SavedObjectsExportByObjectOptions extends SavedObjectExportBaseOptions -``` -Extends: SavedObjectExportBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md) | Array<{ id: string; type: string; }> | optional array of objects to export. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md deleted file mode 100644 index a821ffee153be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByObjectOptions](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.md) > [objects](./kibana-plugin-core-server.savedobjectsexportbyobjectoptions.objects.md) - -## SavedObjectsExportByObjectOptions.objects property - -optional array of objects to export. - -Signature: - -```typescript -objects: Array<{ - id: string; - type: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md deleted file mode 100644 index a58818e27328a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [hasReference](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md) - -## SavedObjectsExportByTypeOptions.hasReference property - -optional array of references to search object for. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md deleted file mode 100644 index 694e9c0cb14d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) - -## SavedObjectsExportByTypeOptions interface - -Options for the [export by type API](./kibana-plugin-core-server.isavedobjectsexporter.exportbytypes.md) - -Signature: - -```typescript -export interface SavedObjectsExportByTypeOptions extends SavedObjectExportBaseOptions -``` -Extends: SavedObjectExportBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [hasReference?](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.hasreference.md) | SavedObjectsFindOptionsReference\[\] | (Optional) optional array of references to search object for. | -| [search?](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md) | string | (Optional) optional query string to filter exported objects. | -| [types](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md) | string\[\] | array of saved object types. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md deleted file mode 100644 index ce8c2c87ddaf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [search](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.search.md) - -## SavedObjectsExportByTypeOptions.search property - -optional query string to filter exported objects. - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md deleted file mode 100644 index eed71d7f39d23..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportByTypeOptions](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.md) > [types](./kibana-plugin-core-server.savedobjectsexportbytypeoptions.types.md) - -## SavedObjectsExportByTypeOptions.types property - -array of saved object types. - -Signature: - -```typescript -types: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md deleted file mode 100644 index ee25dbf8c22e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [(constructor)](./kibana-plugin-core-server.savedobjectsexporterror._constructor_.md) - -## SavedObjectsExportError.(constructor) - -Constructs a new instance of the `SavedObjectsExportError` class - -Signature: - -```typescript -constructor(type: string, message: string, attributes?: Record | undefined); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| message | string | | -| attributes | Record<string, any> \| undefined | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md deleted file mode 100644 index 9061399eab1f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [attributes](./kibana-plugin-core-server.savedobjectsexporterror.attributes.md) - -## SavedObjectsExportError.attributes property - -Signature: - -```typescript -readonly attributes?: Record | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md deleted file mode 100644 index b69c46383aae4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [exportSizeExceeded](./kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md) - -## SavedObjectsExportError.exportSizeExceeded() method - -Signature: - -```typescript -static exportSizeExceeded(limit: number): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md deleted file mode 100644 index a6f0190f27fb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [invalidTransformError](./kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md) - -## SavedObjectsExportError.invalidTransformError() method - -Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) performed an invalid operation during the transform, such as removing objects from the export, or changing an object's type or id. - -Signature: - -```typescript -static invalidTransformError(objectKeys: string[]): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objectKeys | string\[\] | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md deleted file mode 100644 index 4c70b8395d8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) - -## SavedObjectsExportError class - - -Signature: - -```typescript -export declare class SavedObjectsExportError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(type, message, attributes)](./kibana-plugin-core-server.savedobjectsexporterror._constructor_.md) | | Constructs a new instance of the SavedObjectsExportError class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [attributes?](./kibana-plugin-core-server.savedobjectsexporterror.attributes.md) | | Record<string, any> \| undefined | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsexporterror.type.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [exportSizeExceeded(limit)](./kibana-plugin-core-server.savedobjectsexporterror.exportsizeexceeded.md) | static | | -| [invalidTransformError(objectKeys)](./kibana-plugin-core-server.savedobjectsexporterror.invalidtransformerror.md) | static | Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) performed an invalid operation during the transform, such as removing objects from the export, or changing an object's type or id. | -| [objectFetchError(objects)](./kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md) | static | | -| [objectTransformError(objects, cause)](./kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md) | static | Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) threw an error | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md deleted file mode 100644 index 172b9e0f3ef18..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [objectFetchError](./kibana-plugin-core-server.savedobjectsexporterror.objectfetcherror.md) - -## SavedObjectsExportError.objectFetchError() method - -Signature: - -```typescript -static objectFetchError(objects: SavedObject[]): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md deleted file mode 100644 index 46d415068e9e5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [objectTransformError](./kibana-plugin-core-server.savedobjectsexporterror.objecttransformerror.md) - -## SavedObjectsExportError.objectTransformError() method - -Error returned when a [export transform](./kibana-plugin-core-server.savedobjectsexporttransform.md) threw an error - -Signature: - -```typescript -static objectTransformError(objects: SavedObject[], cause: Error): SavedObjectsExportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | -| cause | Error | | - -Returns: - -SavedObjectsExportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md deleted file mode 100644 index 0c1cda48246ad..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportError](./kibana-plugin-core-server.savedobjectsexporterror.md) > [type](./kibana-plugin-core-server.savedobjectsexporterror.type.md) - -## SavedObjectsExportError.type property - -Signature: - -```typescript -readonly type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md deleted file mode 100644 index f7b96e71c8e53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [id](./kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md) - -## SavedObjectsExportExcludedObject.id property - -id of the excluded object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md deleted file mode 100644 index 053e9b8bec463..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) - -## SavedObjectsExportExcludedObject interface - - -Signature: - -```typescript -export interface SavedObjectsExportExcludedObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsexportexcludedobject.id.md) | string | id of the excluded object | -| [reason?](./kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md) | string | (Optional) optional cause of the exclusion | -| [type](./kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md) | string | type of the excluded object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md deleted file mode 100644 index 0adb1ba35e696..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [reason](./kibana-plugin-core-server.savedobjectsexportexcludedobject.reason.md) - -## SavedObjectsExportExcludedObject.reason property - -optional cause of the exclusion - -Signature: - -```typescript -reason?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md deleted file mode 100644 index be28ac2d0ffb6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportExcludedObject](./kibana-plugin-core-server.savedobjectsexportexcludedobject.md) > [type](./kibana-plugin-core-server.savedobjectsexportexcludedobject.type.md) - -## SavedObjectsExportExcludedObject.type property - -type of the excluded object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md deleted file mode 100644 index 90432bf6d6705..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [excludedObjects](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md) - -## SavedObjectsExportResultDetails.excludedObjects property - -excluded objects details - -Signature: - -```typescript -excludedObjects: SavedObjectsExportExcludedObject[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md deleted file mode 100644 index 05846e28b9cab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [excludedObjectsCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md) - -## SavedObjectsExportResultDetails.excludedObjectsCount property - -number of objects that were excluded from the export - -Signature: - -```typescript -excludedObjectsCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md deleted file mode 100644 index 4ff59fcc2bce4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [exportedCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md) - -## SavedObjectsExportResultDetails.exportedCount property - -number of successfully exported objects - -Signature: - -```typescript -exportedCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md deleted file mode 100644 index 872147dc81456..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) - -## SavedObjectsExportResultDetails interface - -Structure of the export result details entry - -Signature: - -```typescript -export interface SavedObjectsExportResultDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excludedObjects](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjects.md) | SavedObjectsExportExcludedObject\[\] | excluded objects details | -| [excludedObjectsCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.excludedobjectscount.md) | number | number of objects that were excluded from the export | -| [exportedCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.exportedcount.md) | number | number of successfully exported objects | -| [missingRefCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md) | number | number of missing references | -| [missingReferences](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md) | Array<{ id: string; type: string; }> | missing references details | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md deleted file mode 100644 index dfab4699ede7c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [missingRefCount](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingrefcount.md) - -## SavedObjectsExportResultDetails.missingRefCount property - -number of missing references - -Signature: - -```typescript -missingRefCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md deleted file mode 100644 index a5b51c38a4cab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md) > [missingReferences](./kibana-plugin-core-server.savedobjectsexportresultdetails.missingreferences.md) - -## SavedObjectsExportResultDetails.missingReferences property - -missing references details - -Signature: - -```typescript -missingReferences: Array<{ - id: string; - type: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md deleted file mode 100644 index 2f83d5188e891..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransform.md +++ /dev/null @@ -1,84 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransform](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -## SavedObjectsExportTransform type - -Transformation function used to mutate the exported objects of the associated type. - -A type's export transform function will be executed once per user-initiated export, for all objects of that type. - -Signature: - -```typescript -export declare type SavedObjectsExportTransform = (context: SavedObjectsExportTransformContext, objects: Array>) => SavedObject[] | Promise; -``` - -## Remarks - -Trying to change an object's id or type during the transform will result in a runtime error during the export process. - -## Example 1 - -Registering a transform function changing the object's attributes during the export - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: (ctx, objects) => { - return objects.map((obj) => ({ - ...obj, - attributes: { - ...obj.attributes, - enabled: false, - } - }) - } - }, - }); - } -} -``` - -## Example 2 - -Registering a transform function adding additional objects to the export - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - const savedObjectStartContractPromise = getStartServices().then( - ([{ savedObjects: savedObjectsStart }]) => savedObjectsStart - ); - - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onExport: async (ctx, objects) => { - const { getScopedClient } = await savedObjectStartContractPromise; - const client = getScopedClient(ctx.request); - - const depResponse = await client.find({ - type: 'my-nested-object', - hasReference: objs.map(({ id, type }) => ({ id, type })), - }); - - return [...objs, ...depResponse.saved_objects]; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md deleted file mode 100644 index c277308c6fc3b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) - -## SavedObjectsExportTransformContext interface - -Context passed down to a [export transform function](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -Signature: - -```typescript -export interface SavedObjectsExportTransformContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [request](./kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md) | KibanaRequest | The request that initiated the export request. Can be used to create scoped services or client inside the [transformation](./kibana-plugin-core-server.savedobjectsexporttransform.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md deleted file mode 100644 index fe04698899c7c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsExportTransformContext](./kibana-plugin-core-server.savedobjectsexporttransformcontext.md) > [request](./kibana-plugin-core-server.savedobjectsexporttransformcontext.request.md) - -## SavedObjectsExportTransformContext.request property - -The request that initiated the export request. Can be used to create scoped services or client inside the [transformation](./kibana-plugin-core-server.savedobjectsexporttransform.md) - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md deleted file mode 100644 index cf5b5d7e6e339..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfieldmapping.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md) - -## SavedObjectsFieldMapping type - -Describe a [saved object type mapping](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) field. - -Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation - -Signature: - -```typescript -export declare type SavedObjectsFieldMapping = estypes.MappingProperty & { - dynamic?: false | 'strict'; - properties?: Record; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md deleted file mode 100644 index b716ed43948e4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [defaultSearchOperator](./kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md) - -## SavedObjectsFindOptions.defaultSearchOperator property - -The search operator to use with the provided filter. Defaults to `OR` - -Signature: - -```typescript -defaultSearchOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md deleted file mode 100644 index bb7d0a8ff861c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.fields.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [fields](./kibana-plugin-core-server.savedobjectsfindoptions.fields.md) - -## SavedObjectsFindOptions.fields property - -An array of fields to include in the results - -Signature: - -```typescript -fields?: string[]; -``` - -## Example - -SavedObjects.find({type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]}) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md deleted file mode 100644 index c98a4fe5e8796..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.filter.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [filter](./kibana-plugin-core-server.savedobjectsfindoptions.filter.md) - -## SavedObjectsFindOptions.filter property - -Signature: - -```typescript -filter?: string | KueryNode; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md deleted file mode 100644 index dea3d55950789..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [hasReference](./kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md) - -## SavedObjectsFindOptions.hasReference property - -Search for documents having a reference to the specified objects. Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - -Signature: - -```typescript -hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md deleted file mode 100644 index 2c06f76d5c736..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [hasReferenceOperator](./kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md) - -## SavedObjectsFindOptions.hasReferenceOperator property - -The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - -Signature: - -```typescript -hasReferenceOperator?: 'AND' | 'OR'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md deleted file mode 100644 index 9e87eff2f1232..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) - -## SavedObjectsFindOptions interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchOperator?](./kibana-plugin-core-server.savedobjectsfindoptions.defaultsearchoperator.md) | 'AND' \| 'OR' | (Optional) The search operator to use with the provided filter. Defaults to OR | -| [fields?](./kibana-plugin-core-server.savedobjectsfindoptions.fields.md) | string\[\] | (Optional) An array of fields to include in the results | -| [filter?](./kibana-plugin-core-server.savedobjectsfindoptions.filter.md) | string \| KueryNode | (Optional) | -| [hasReference?](./kibana-plugin-core-server.savedobjectsfindoptions.hasreference.md) | SavedObjectsFindOptionsReference \| SavedObjectsFindOptionsReference\[\] | (Optional) Search for documents having a reference to the specified objects. Use hasReferenceOperator to specify the operator to use when searching for multiple references. | -| [hasReferenceOperator?](./kibana-plugin-core-server.savedobjectsfindoptions.hasreferenceoperator.md) | 'AND' \| 'OR' | (Optional) The operator to use when searching by multiple references using the hasReference option. Defaults to OR | -| [namespaces?](./kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md) | string\[\] | (Optional) | -| [page?](./kibana-plugin-core-server.savedobjectsfindoptions.page.md) | number | (Optional) | -| [perPage?](./kibana-plugin-core-server.savedobjectsfindoptions.perpage.md) | number | (Optional) | -| [pit?](./kibana-plugin-core-server.savedobjectsfindoptions.pit.md) | SavedObjectsPitParams | (Optional) Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). | -| [preference?](./kibana-plugin-core-server.savedobjectsfindoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query \* | -| [rootSearchFields?](./kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. Unlike the searchFields argument, these are expected to be root fields and will not be modified. If used in conjunction with searchFields, both are concatenated together. | -| [search?](./kibana-plugin-core-server.savedobjectsfindoptions.search.md) | string | (Optional) Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String query argument for more information | -| [searchAfter?](./kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md) | estypes.Id\[\] | (Optional) Use the sort values from the previous page to retrieve the next page of results. | -| [searchFields?](./kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md) | string\[\] | (Optional) The fields to perform the parsed query against. See Elasticsearch Simple Query String fields argument for more information | -| [sortField?](./kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md) | string | (Optional) | -| [sortOrder?](./kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md) | estypes.SortOrder | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsfindoptions.type.md) | string \| string\[\] | | -| [typeToNamespacesMap?](./kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md) | Map<string, string\[\] \| undefined> | (Optional) This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the type and namespaces fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md deleted file mode 100644 index cae707baa58c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [namespaces](./kibana-plugin-core-server.savedobjectsfindoptions.namespaces.md) - -## SavedObjectsFindOptions.namespaces property - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md deleted file mode 100644 index 5a2f05af843b9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [page](./kibana-plugin-core-server.savedobjectsfindoptions.page.md) - -## SavedObjectsFindOptions.page property - -Signature: - -```typescript -page?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md deleted file mode 100644 index 39191ae00c8f9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.perpage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [perPage](./kibana-plugin-core-server.savedobjectsfindoptions.perpage.md) - -## SavedObjectsFindOptions.perPage property - -Signature: - -```typescript -perPage?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md deleted file mode 100644 index fac333227088c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.pit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [pit](./kibana-plugin-core-server.savedobjectsfindoptions.pit.md) - -## SavedObjectsFindOptions.pit property - -Search against a specific Point In Time (PIT) that you've opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -Signature: - -```typescript -pit?: SavedObjectsPitParams; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md deleted file mode 100644 index c9e1c168e7a1b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [preference](./kibana-plugin-core-server.savedobjectsfindoptions.preference.md) - -## SavedObjectsFindOptions.preference property - -An optional ES preference value to be used for the query \* - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md deleted file mode 100644 index 204342c45f64e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [rootSearchFields](./kibana-plugin-core-server.savedobjectsfindoptions.rootsearchfields.md) - -## SavedObjectsFindOptions.rootSearchFields property - -The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not be modified. If used in conjunction with `searchFields`, both are concatenated together. - -Signature: - -```typescript -rootSearchFields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md deleted file mode 100644 index fdf7cc1fb94c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.search.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [search](./kibana-plugin-core-server.savedobjectsfindoptions.search.md) - -## SavedObjectsFindOptions.search property - -Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information - -Signature: - -```typescript -search?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md deleted file mode 100644 index 9afd602259a78..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [searchAfter](./kibana-plugin-core-server.savedobjectsfindoptions.searchafter.md) - -## SavedObjectsFindOptions.searchAfter property - -Use the sort values from the previous page to retrieve the next page of results. - -Signature: - -```typescript -searchAfter?: estypes.Id[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md deleted file mode 100644 index ba1152c05eb37..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [searchFields](./kibana-plugin-core-server.savedobjectsfindoptions.searchfields.md) - -## SavedObjectsFindOptions.searchFields property - -The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information - -Signature: - -```typescript -searchFields?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md deleted file mode 100644 index 1dffe996d5726..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [sortField](./kibana-plugin-core-server.savedobjectsfindoptions.sortfield.md) - -## SavedObjectsFindOptions.sortField property - -Signature: - -```typescript -sortField?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md deleted file mode 100644 index e1c657e3a5171..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [sortOrder](./kibana-plugin-core-server.savedobjectsfindoptions.sortorder.md) - -## SavedObjectsFindOptions.sortOrder property - -Signature: - -```typescript -sortOrder?: estypes.SortOrder; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md deleted file mode 100644 index b1503984fdd44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [type](./kibana-plugin-core-server.savedobjectsfindoptions.type.md) - -## SavedObjectsFindOptions.type property - -Signature: - -```typescript -type: string | string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md deleted file mode 100644 index 8bec759f05580..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) > [typeToNamespacesMap](./kibana-plugin-core-server.savedobjectsfindoptions.typetonamespacesmap.md) - -## SavedObjectsFindOptions.typeToNamespacesMap property - -This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved object client wrapper. If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. Any types that are not included in this map will be excluded entirely. If a type is included but its value is undefined, the operation will search for that type in the Default namespace. - -Signature: - -```typescript -typeToNamespacesMap?: Map; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md deleted file mode 100644 index 6d5b76d685680..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) > [id](./kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md) - -## SavedObjectsFindOptionsReference.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md deleted file mode 100644 index 21eb9f06cc11d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) - -## SavedObjectsFindOptionsReference interface - - -Signature: - -```typescript -export interface SavedObjectsFindOptionsReference -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsfindoptionsreference.id.md) | string | | -| [type](./kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md deleted file mode 100644 index 0d7db3d72a457..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindOptionsReference](./kibana-plugin-core-server.savedobjectsfindoptionsreference.md) > [type](./kibana-plugin-core-server.savedobjectsfindoptionsreference.type.md) - -## SavedObjectsFindOptionsReference.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md deleted file mode 100644 index 17a899f4c8280..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) - -## SavedObjectsFindResponse.aggregations property - -Signature: - -```typescript -aggregations?: A; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md deleted file mode 100644 index 4afb825fd0f44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) - -## SavedObjectsFindResponse interface - -Return type of the Saved Objects `find()` method. - -\*Note\*: this type is different between the Public and Server Saved Objects clients. - -Signature: - -```typescript -export interface SavedObjectsFindResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [aggregations?](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) | A | (Optional) | -| [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) | number | | -| [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) | number | | -| [pit\_id?](./kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md) | string | (Optional) | -| [saved\_objects](./kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md) | Array<SavedObjectsFindResult<T>> | | -| [total](./kibana-plugin-core-server.savedobjectsfindresponse.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md deleted file mode 100644 index 82e18ac4f3f8f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) - -## SavedObjectsFindResponse.page property - -Signature: - -```typescript -page: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md deleted file mode 100644 index 551aea487fe4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.per_page.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) - -## SavedObjectsFindResponse.per\_page property - -Signature: - -```typescript -per_page: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md deleted file mode 100644 index dc4f9b509d606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [pit\_id](./kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md) - -## SavedObjectsFindResponse.pit\_id property - -Signature: - -```typescript -pit_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md deleted file mode 100644 index 7a91367f6ef0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [saved\_objects](./kibana-plugin-core-server.savedobjectsfindresponse.saved_objects.md) - -## SavedObjectsFindResponse.saved\_objects property - -Signature: - -```typescript -saved_objects: Array>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md deleted file mode 100644 index 3a6b4309f2e7a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresponse.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) > [total](./kibana-plugin-core-server.savedobjectsfindresponse.total.md) - -## SavedObjectsFindResponse.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md deleted file mode 100644 index f2ba01697da17..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) - -## SavedObjectsFindResult interface - - -Signature: - -```typescript -export interface SavedObjectsFindResult extends SavedObject -``` -Extends: SavedObject<T> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [score](./kibana-plugin-core-server.savedobjectsfindresult.score.md) | number | The Elasticsearch _score of this result. | -| [sort?](./kibana-plugin-core-server.savedobjectsfindresult.sort.md) | string\[\] | (Optional) The Elasticsearch sort value of this result. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md deleted file mode 100644 index c6646df6ee470..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.score.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) > [score](./kibana-plugin-core-server.savedobjectsfindresult.score.md) - -## SavedObjectsFindResult.score property - -The Elasticsearch `_score` of this result. - -Signature: - -```typescript -score: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md deleted file mode 100644 index 5df1b3291b072..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsfindresult.sort.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsFindResult](./kibana-plugin-core-server.savedobjectsfindresult.md) > [sort](./kibana-plugin-core-server.savedobjectsfindresult.sort.md) - -## SavedObjectsFindResult.sort property - -The Elasticsearch `sort` value of this result. - -Signature: - -```typescript -sort?: string[]; -``` - -## Remarks - -This can be passed directly to the `searchAfter` param in the [SavedObjectsFindOptions](./kibana-plugin-core-server.savedobjectsfindoptions.md) in order to page through large numbers of hits. It is recommended you use this alongside a Point In Time (PIT) that was opened with [SavedObjectsClient.openPointInTimeForType()](./kibana-plugin-core-server.savedobjectsclient.openpointintimefortype.md). - -## Example - - -```ts -const { id } = await savedObjectsClient.openPointInTimeForType('visualization'); -const page1 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id }, -}); -const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; -const page2 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id: page1.pit_id }, - searchAfter: lastHit.sort, -}); -await savedObjectsClient.closePointInTime(page2.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md deleted file mode 100644 index f52fd9057d9d0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) - -## SavedObjectsImportActionRequiredWarning.actionPath property - -The path (without the basePath) that the user should be redirect to address this warning. - -Signature: - -```typescript -actionPath: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md deleted file mode 100644 index 7fb5d53c487af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [buttonLabel](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md) - -## SavedObjectsImportActionRequiredWarning.buttonLabel property - -An optional label to use for the link button. If unspecified, a default label will be used. - -Signature: - -```typescript -buttonLabel?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md deleted file mode 100644 index c4ec5fdd2f8e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) - -## SavedObjectsImportActionRequiredWarning interface - -A warning meant to notify that a specific user action is required to finalize the import of some type of object. - - The `actionUrl` must be a path relative to the basePath, and not include it. - -Signature: - -```typescript -export interface SavedObjectsImportActionRequiredWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [actionPath](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.actionpath.md) | string | The path (without the basePath) that the user should be redirect to address this warning. | -| [buttonLabel?](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.buttonlabel.md) | string | (Optional) An optional label to use for the link button. If unspecified, a default label will be used. | -| [message](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md) | string | The translated message to display to the user. | -| [type](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md) | 'action\_required' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md deleted file mode 100644 index 1ab9afd4bad99..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [message](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.message.md) - -## SavedObjectsImportActionRequiredWarning.message property - -The translated message to display to the user. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md deleted file mode 100644 index d8f22ef17d8f0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) > [type](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.type.md) - -## SavedObjectsImportActionRequiredWarning.type property - -Signature: - -```typescript -type: 'action_required'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md deleted file mode 100644 index 445979dd740d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) > [destinations](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md) - -## SavedObjectsImportAmbiguousConflictError.destinations property - -Signature: - -```typescript -destinations: Array<{ - id: string; - title?: string; - updatedAt?: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md deleted file mode 100644 index 7d275fa199c5b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) - -## SavedObjectsImportAmbiguousConflictError interface - -Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. - -Signature: - -```typescript -export interface SavedObjectsImportAmbiguousConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinations](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.destinations.md) | Array<{ id: string; title?: string; updatedAt?: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md) | 'ambiguous\_conflict' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md deleted file mode 100644 index ca98682873033..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.md) > [type](./kibana-plugin-core-server.savedobjectsimportambiguousconflicterror.type.md) - -## SavedObjectsImportAmbiguousConflictError.type property - -Signature: - -```typescript -type: 'ambiguous_conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md deleted file mode 100644 index 858f171223472..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md) - -## SavedObjectsImportConflictError.destinationId property - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md deleted file mode 100644 index 9456e042035fe..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) - -## SavedObjectsImportConflictError interface - -Represents a failure to import due to a conflict. - -Signature: - -```typescript -export interface SavedObjectsImportConflictError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportconflicterror.destinationid.md) | string | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsimportconflicterror.type.md) | 'conflict' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md deleted file mode 100644 index 15ceed56fb22f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportconflicterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportConflictError](./kibana-plugin-core-server.savedobjectsimportconflicterror.md) > [type](./kibana-plugin-core-server.savedobjectsimportconflicterror.type.md) - -## SavedObjectsImportConflictError.type property - -Signature: - -```typescript -type: 'conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md deleted file mode 100644 index 6d09d4cb88120..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [attributes](./kibana-plugin-core-server.savedobjectsimporterror.attributes.md) - -## SavedObjectsImportError.attributes property - -Signature: - -```typescript -readonly attributes?: Record | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md deleted file mode 100644 index 421557445670e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [importSizeExceeded](./kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md) - -## SavedObjectsImportError.importSizeExceeded() method - -Signature: - -```typescript -static importSizeExceeded(limit: number): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md deleted file mode 100644 index 2e4fd1a01eb04..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) - -## SavedObjectsImportError class - - -Signature: - -```typescript -export declare class SavedObjectsImportError extends Error -``` -Extends: Error - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [attributes?](./kibana-plugin-core-server.savedobjectsimporterror.attributes.md) | | Record<string, any> \| undefined | (Optional) | -| [type](./kibana-plugin-core-server.savedobjectsimporterror.type.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [importSizeExceeded(limit)](./kibana-plugin-core-server.savedobjectsimporterror.importsizeexceeded.md) | static | | -| [nonUniqueImportObjects(nonUniqueEntries)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md) | static | | -| [nonUniqueRetryDestinations(nonUniqueRetryDestinations)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md) | static | | -| [nonUniqueRetryObjects(nonUniqueRetryObjects)](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md) | static | | -| [referencesFetchError(objects)](./kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md) | static | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md deleted file mode 100644 index 29533db10302c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueImportObjects](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueimportobjects.md) - -## SavedObjectsImportError.nonUniqueImportObjects() method - -Signature: - -```typescript -static nonUniqueImportObjects(nonUniqueEntries: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueEntries | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md deleted file mode 100644 index 4fd23c3f6d62d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueRetryDestinations](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretrydestinations.md) - -## SavedObjectsImportError.nonUniqueRetryDestinations() method - -Signature: - -```typescript -static nonUniqueRetryDestinations(nonUniqueRetryDestinations: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueRetryDestinations | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md deleted file mode 100644 index bf8a2c2c01760..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [nonUniqueRetryObjects](./kibana-plugin-core-server.savedobjectsimporterror.nonuniqueretryobjects.md) - -## SavedObjectsImportError.nonUniqueRetryObjects() method - -Signature: - -```typescript -static nonUniqueRetryObjects(nonUniqueRetryObjects: string[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| nonUniqueRetryObjects | string\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md deleted file mode 100644 index 4202f164900b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [referencesFetchError](./kibana-plugin-core-server.savedobjectsimporterror.referencesfetcherror.md) - -## SavedObjectsImportError.referencesFetchError() method - -Signature: - -```typescript -static referencesFetchError(objects: SavedObject[]): SavedObjectsImportError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObject\[\] | | - -Returns: - -SavedObjectsImportError - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md deleted file mode 100644 index db655f8cfa129..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporterror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportError](./kibana-plugin-core-server.savedobjectsimporterror.md) > [type](./kibana-plugin-core-server.savedobjectsimporterror.type.md) - -## SavedObjectsImportError.type property - -Signature: - -```typescript -readonly type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md deleted file mode 100644 index 40c9fa1fefa91..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [error](./kibana-plugin-core-server.savedobjectsimportfailure.error.md) - -## SavedObjectsImportFailure.error property - -Signature: - -```typescript -error: SavedObjectsImportConflictError | SavedObjectsImportAmbiguousConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md deleted file mode 100644 index a58183b84e401..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [id](./kibana-plugin-core-server.savedobjectsimportfailure.id.md) - -## SavedObjectsImportFailure.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md deleted file mode 100644 index 4bdc3d99028ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) - -## SavedObjectsImportFailure interface - -Represents a failure to import. - -Signature: - -```typescript -export interface SavedObjectsImportFailure -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-server.savedobjectsimportfailure.error.md) | SavedObjectsImportConflictError \| SavedObjectsImportAmbiguousConflictError \| SavedObjectsImportUnsupportedTypeError \| SavedObjectsImportMissingReferencesError \| SavedObjectsImportUnknownError | | -| [id](./kibana-plugin-core-server.savedobjectsimportfailure.id.md) | string | | -| [meta](./kibana-plugin-core-server.savedobjectsimportfailure.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md) | boolean | (Optional) If overwrite is specified, an attempt was made to overwrite an existing object. | -| [type](./kibana-plugin-core-server.savedobjectsimportfailure.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md deleted file mode 100644 index c345ebe28b945..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [meta](./kibana-plugin-core-server.savedobjectsimportfailure.meta.md) - -## SavedObjectsImportFailure.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md deleted file mode 100644 index 0bd3f1c1d72e8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportfailure.overwrite.md) - -## SavedObjectsImportFailure.overwrite property - -If `overwrite` is specified, an attempt was made to overwrite an existing object. - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md deleted file mode 100644 index ff1529eb8db7a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportfailure.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportFailure](./kibana-plugin-core-server.savedobjectsimportfailure.md) > [type](./kibana-plugin-core-server.savedobjectsimportfailure.type.md) - -## SavedObjectsImportFailure.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md deleted file mode 100644 index 8d50ef94577de..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthook.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHook](./kibana-plugin-core-server.savedobjectsimporthook.md) - -## SavedObjectsImportHook type - -A hook associated with a specific saved object type, that will be invoked during the import process. The hook will have access to the objects of the registered type. - -Currently, the only supported feature for import hooks is to return warnings to be displayed in the UI when the import succeeds. - - The only interactions the hook can have with the import process is via the hook's response. Mutating the objects inside the hook's code will have no effect. - -Signature: - -```typescript -export declare type SavedObjectsImportHook = (objects: Array>) => SavedObjectsImportHookResult | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md deleted file mode 100644 index eb16aa2fb0285..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) - -## SavedObjectsImportHookResult interface - -Result from a [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) - -Signature: - -```typescript -export interface SavedObjectsImportHookResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [warnings?](./kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md) | SavedObjectsImportWarning\[\] | (Optional) An optional list of warnings to display in the UI when the import succeeds. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md deleted file mode 100644 index 682b384f8d363..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportHookResult](./kibana-plugin-core-server.savedobjectsimporthookresult.md) > [warnings](./kibana-plugin-core-server.savedobjectsimporthookresult.warnings.md) - -## SavedObjectsImportHookResult.warnings property - -An optional list of warnings to display in the UI when the import succeeds. - -Signature: - -```typescript -warnings?: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md deleted file mode 100644 index 25d2a88e87e8b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) - -## SavedObjectsImportMissingReferencesError interface - -Represents a failure to import due to missing references. - -Signature: - -```typescript -export interface SavedObjectsImportMissingReferencesError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md) | Array<{ type: string; id: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md) | 'missing\_references' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md deleted file mode 100644 index f8255e8c75f92..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) > [references](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.references.md) - -## SavedObjectsImportMissingReferencesError.references property - -Signature: - -```typescript -references: Array<{ - type: string; - id: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md deleted file mode 100644 index 4499f82ed92ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.md) > [type](./kibana-plugin-core-server.savedobjectsimportmissingreferenceserror.type.md) - -## SavedObjectsImportMissingReferencesError.type property - -Signature: - -```typescript -type: 'missing_references'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md deleted file mode 100644 index 23c6fe0051746..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [createNewCopies](./kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md) - -## SavedObjectsImportOptions.createNewCopies property - -If true, will create new copies of import objects, each with a random `id` and undefined `originId`. - -Signature: - -```typescript -createNewCopies: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md deleted file mode 100644 index 775f3a4c9acb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) - -## SavedObjectsImportOptions interface - -Options to control the import operation. - -Signature: - -```typescript -export interface SavedObjectsImportOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopies](./kibana-plugin-core-server.savedobjectsimportoptions.createnewcopies.md) | boolean | If true, will create new copies of import objects, each with a random id and undefined originId. | -| [namespace?](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) | string | (Optional) if specified, will import in given namespace, else will import as global object | -| [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) | boolean | If true, will override existing object if present. Note: this has no effect when used with the createNewCopies option. | -| [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import | -| [refresh?](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) | boolean \| 'wait\_for' | (Optional) Refresh setting, defaults to wait_for | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md deleted file mode 100644 index 188ff03092e0c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) - -## SavedObjectsImportOptions.namespace property - -if specified, will import in given namespace, else will import as global object - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md deleted file mode 100644 index 1e9192c47679d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) - -## SavedObjectsImportOptions.overwrite property - -If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option. - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md deleted file mode 100644 index bf68ee47d21fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.readstream.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) - -## SavedObjectsImportOptions.readStream property - -The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import - -Signature: - -```typescript -readStream: Readable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md deleted file mode 100644 index cc7e36354647a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) - -## SavedObjectsImportOptions.refresh property - -Refresh setting, defaults to `wait_for` - -Signature: - -```typescript -refresh?: boolean | 'wait_for'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md deleted file mode 100644 index dc6f782fc937f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.errors.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [errors](./kibana-plugin-core-server.savedobjectsimportresponse.errors.md) - -## SavedObjectsImportResponse.errors property - -Signature: - -```typescript -errors?: SavedObjectsImportFailure[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md deleted file mode 100644 index e39b4b02bb55d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) - -## SavedObjectsImportResponse interface - -The response describing the result of an import. - -Signature: - -```typescript -export interface SavedObjectsImportResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [errors?](./kibana-plugin-core-server.savedobjectsimportresponse.errors.md) | SavedObjectsImportFailure\[\] | (Optional) | -| [success](./kibana-plugin-core-server.savedobjectsimportresponse.success.md) | boolean | | -| [successCount](./kibana-plugin-core-server.savedobjectsimportresponse.successcount.md) | number | | -| [successResults?](./kibana-plugin-core-server.savedobjectsimportresponse.successresults.md) | SavedObjectsImportSuccess\[\] | (Optional) | -| [warnings](./kibana-plugin-core-server.savedobjectsimportresponse.warnings.md) | SavedObjectsImportWarning\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md deleted file mode 100644 index fc4f98cd2556e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.success.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [success](./kibana-plugin-core-server.savedobjectsimportresponse.success.md) - -## SavedObjectsImportResponse.success property - -Signature: - -```typescript -success: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md deleted file mode 100644 index 3186437a10482..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [successCount](./kibana-plugin-core-server.savedobjectsimportresponse.successcount.md) - -## SavedObjectsImportResponse.successCount property - -Signature: - -```typescript -successCount: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md deleted file mode 100644 index 63951d3a0b25f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.successresults.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [successResults](./kibana-plugin-core-server.savedobjectsimportresponse.successresults.md) - -## SavedObjectsImportResponse.successResults property - -Signature: - -```typescript -successResults?: SavedObjectsImportSuccess[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md deleted file mode 100644 index 88cccf7f527e7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportresponse.warnings.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportResponse](./kibana-plugin-core-server.savedobjectsimportresponse.md) > [warnings](./kibana-plugin-core-server.savedobjectsimportresponse.warnings.md) - -## SavedObjectsImportResponse.warnings property - -Signature: - -```typescript -warnings: SavedObjectsImportWarning[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md deleted file mode 100644 index e9cc92c55ded1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [createNewCopy](./kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md) - -## SavedObjectsImportRetry.createNewCopy property - -If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md deleted file mode 100644 index 9a3ccf4442db7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportretry.destinationid.md) - -## SavedObjectsImportRetry.destinationId property - -The object ID that will be created or overwritten. If not specified, the `id` field will be used. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md deleted file mode 100644 index d42b1e3ad7581..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [id](./kibana-plugin-core-server.savedobjectsimportretry.id.md) - -## SavedObjectsImportRetry.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md deleted file mode 100644 index a23bec3c5341f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [ignoreMissingReferences](./kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md) - -## SavedObjectsImportRetry.ignoreMissingReferences property - -If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. - -Signature: - -```typescript -ignoreMissingReferences?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md deleted file mode 100644 index b79ec63ed86c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) - -## SavedObjectsImportRetry interface - -Describes a retry operation for importing a saved object. - -Signature: - -```typescript -export interface SavedObjectsImportRetry -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-server.savedobjectsimportretry.createnewcopy.md) | boolean | (Optional) If createNewCopy is specified, the new object has a new (undefined) origin ID. This is only needed for the case where createNewCopies mode is disabled and ambiguous source conflicts are detected. | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportretry.destinationid.md) | string | (Optional) The object ID that will be created or overwritten. If not specified, the id field will be used. | -| [id](./kibana-plugin-core-server.savedobjectsimportretry.id.md) | string | | -| [ignoreMissingReferences?](./kibana-plugin-core-server.savedobjectsimportretry.ignoremissingreferences.md) | boolean | (Optional) If ignoreMissingReferences is specified, reference validation will be skipped for this object. | -| [overwrite](./kibana-plugin-core-server.savedobjectsimportretry.overwrite.md) | boolean | | -| [replaceReferences](./kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md) | Array<{ type: string; from: string; to: string; }> | | -| [type](./kibana-plugin-core-server.savedobjectsimportretry.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md deleted file mode 100644 index f4358ab986563..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.overwrite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportretry.overwrite.md) - -## SavedObjectsImportRetry.overwrite property - -Signature: - -```typescript -overwrite: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md deleted file mode 100644 index b25940d9ab2ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [replaceReferences](./kibana-plugin-core-server.savedobjectsimportretry.replacereferences.md) - -## SavedObjectsImportRetry.replaceReferences property - -Signature: - -```typescript -replaceReferences: Array<{ - type: string; - from: string; - to: string; - }>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md deleted file mode 100644 index 2e434c4a57e9b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportretry.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportRetry](./kibana-plugin-core-server.savedobjectsimportretry.md) > [type](./kibana-plugin-core-server.savedobjectsimportretry.type.md) - -## SavedObjectsImportRetry.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md deleted file mode 100644 index 7dc4285400478..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) - -## SavedObjectsImportSimpleWarning interface - -A simple informative warning that will be displayed to the user. - -Signature: - -```typescript -export interface SavedObjectsImportSimpleWarning -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md) | string | The translated message to display to the user | -| [type](./kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md) | 'simple' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md deleted file mode 100644 index 1e3ac7ec11365..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) > [message](./kibana-plugin-core-server.savedobjectsimportsimplewarning.message.md) - -## SavedObjectsImportSimpleWarning.message property - -The translated message to display to the user - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md deleted file mode 100644 index 660b1b39d6c39..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) > [type](./kibana-plugin-core-server.savedobjectsimportsimplewarning.type.md) - -## SavedObjectsImportSimpleWarning.type property - -Signature: - -```typescript -type: 'simple'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md deleted file mode 100644 index 3473a4f4577e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [createNewCopy](./kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md) - -## SavedObjectsImportSuccess.createNewCopy property - -> Warning: This API is now obsolete. -> -> Can be removed when https://github.com/elastic/kibana/issues/91615 is done. If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, this field will be redundant and can be removed. -> - -Signature: - -```typescript -createNewCopy?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md deleted file mode 100644 index c5acc51c3ec99..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [destinationId](./kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md) - -## SavedObjectsImportSuccess.destinationId property - -If `destinationId` is specified, the new object has a new ID that is different from the import ID. - -Signature: - -```typescript -destinationId?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md deleted file mode 100644 index 5b95f7f64bfac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [id](./kibana-plugin-core-server.savedobjectsimportsuccess.id.md) - -## SavedObjectsImportSuccess.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md deleted file mode 100644 index 74242ba6d75be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) - -## SavedObjectsImportSuccess interface - -Represents a successful import. - -Signature: - -```typescript -export interface SavedObjectsImportSuccess -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopy?](./kibana-plugin-core-server.savedobjectsimportsuccess.createnewcopy.md) | boolean | (Optional) | -| [destinationId?](./kibana-plugin-core-server.savedobjectsimportsuccess.destinationid.md) | string | (Optional) If destinationId is specified, the new object has a new ID that is different from the import ID. | -| [id](./kibana-plugin-core-server.savedobjectsimportsuccess.id.md) | string | | -| [meta](./kibana-plugin-core-server.savedobjectsimportsuccess.meta.md) | { title?: string; icon?: string; } | | -| [overwrite?](./kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md) | boolean | (Optional) If overwrite is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). | -| [type](./kibana-plugin-core-server.savedobjectsimportsuccess.type.md) | string | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md deleted file mode 100644 index de6057b4729ec..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.meta.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [meta](./kibana-plugin-core-server.savedobjectsimportsuccess.meta.md) - -## SavedObjectsImportSuccess.meta property - -Signature: - -```typescript -meta: { - title?: string; - icon?: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md deleted file mode 100644 index 80cb659ef2cd2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [overwrite](./kibana-plugin-core-server.savedobjectsimportsuccess.overwrite.md) - -## SavedObjectsImportSuccess.overwrite property - -If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). - -Signature: - -```typescript -overwrite?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md deleted file mode 100644 index e6aa894cd0af9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportsuccess.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) > [type](./kibana-plugin-core-server.savedobjectsimportsuccess.type.md) - -## SavedObjectsImportSuccess.type property - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md deleted file mode 100644 index 158afd45752fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) - -## SavedObjectsImportUnknownError interface - -Represents a failure to import due to an unknown reason. - -Signature: - -```typescript -export interface SavedObjectsImportUnknownError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./kibana-plugin-core-server.savedobjectsimportunknownerror.message.md) | string | | -| [statusCode](./kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md) | number | | -| [type](./kibana-plugin-core-server.savedobjectsimportunknownerror.type.md) | 'unknown' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md deleted file mode 100644 index b5fb8b9db0e10..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.message.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [message](./kibana-plugin-core-server.savedobjectsimportunknownerror.message.md) - -## SavedObjectsImportUnknownError.message property - -Signature: - -```typescript -message: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md deleted file mode 100644 index 0fa38614e8735..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [statusCode](./kibana-plugin-core-server.savedobjectsimportunknownerror.statuscode.md) - -## SavedObjectsImportUnknownError.statusCode property - -Signature: - -```typescript -statusCode: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md deleted file mode 100644 index c22a1dec73789..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunknownerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) > [type](./kibana-plugin-core-server.savedobjectsimportunknownerror.type.md) - -## SavedObjectsImportUnknownError.type property - -Signature: - -```typescript -type: 'unknown'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md deleted file mode 100644 index 48aff60c69d13..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) - -## SavedObjectsImportUnsupportedTypeError interface - -Represents a failure to import due to having an unsupported saved object type. - -Signature: - -```typescript -export interface SavedObjectsImportUnsupportedTypeError -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md) | 'unsupported\_type' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md deleted file mode 100644 index a985d4d8793bb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) > [type](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.type.md) - -## SavedObjectsImportUnsupportedTypeError.type property - -Signature: - -```typescript -type: 'unsupported_type'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md deleted file mode 100644 index 257751f16601d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportwarning.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportWarning](./kibana-plugin-core-server.savedobjectsimportwarning.md) - -## SavedObjectsImportWarning type - -Composite type of all the possible types of import warnings. - -See [SavedObjectsImportSimpleWarning](./kibana-plugin-core-server.savedobjectsimportsimplewarning.md) and [SavedObjectsImportActionRequiredWarning](./kibana-plugin-core-server.savedobjectsimportactionrequiredwarning.md) for more details. - -Signature: - -```typescript -export declare type SavedObjectsImportWarning = SavedObjectsImportSimpleWarning | SavedObjectsImportActionRequiredWarning; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md deleted file mode 100644 index 44c3ab18fea61..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) > [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md) - -## SavedObjectsIncrementCounterField.fieldName property - -The field name to increment the counter by. - -Signature: - -```typescript -fieldName: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md deleted file mode 100644 index dc6f8b114c1c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) > [incrementBy](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md) - -## SavedObjectsIncrementCounterField.incrementBy property - -The number to increment the field by (defaults to 1). - -Signature: - -```typescript -incrementBy?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md deleted file mode 100644 index a45d48523f461..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounterfield.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) - -## SavedObjectsIncrementCounterField interface - - -Signature: - -```typescript -export interface SavedObjectsIncrementCounterField -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md) | string | The field name to increment the counter by. | -| [incrementBy?](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md) | number | (Optional) The number to increment the field by (defaults to 1). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md deleted file mode 100644 index 61091306d0dbc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [initialize](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md) - -## SavedObjectsIncrementCounterOptions.initialize property - -(default=false) If true, sets all the counter fields to 0 if they don't already exist. Existing fields will be left as-is and won't be incremented. - -Signature: - -```typescript -initialize?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md deleted file mode 100644 index 8740ffb1be185..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) - -## SavedObjectsIncrementCounterOptions interface - - -Signature: - -```typescript -export interface SavedObjectsIncrementCounterOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [initialize?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.initialize.md) | boolean | (Optional) (default=false) If true, sets all the counter fields to 0 if they don't already exist. Existing fields will be left as-is and won't be incremented. | -| [migrationVersion?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md) | SavedObjectsMigrationVersion | (Optional) [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) | -| [refresh?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) (default='wait\_for') The Elasticsearch refresh setting for this operation. See [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) | -| [upsertAttributes?](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md) | Attributes | (Optional) Attributes to use when upserting the document if it doesn't exist. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md deleted file mode 100644 index aff80138d61cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [migrationVersion](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.migrationversion.md) - -## SavedObjectsIncrementCounterOptions.migrationVersion property - -[SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) - -Signature: - -```typescript -migrationVersion?: SavedObjectsMigrationVersion; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md deleted file mode 100644 index 4f217cc223d46..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.refresh.md) - -## SavedObjectsIncrementCounterOptions.refresh property - -(default='wait\_for') The Elasticsearch refresh setting for this operation. See [MutatingOperationRefreshSetting](./kibana-plugin-core-server.mutatingoperationrefreshsetting.md) - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md deleted file mode 100644 index d5657dd65771f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) > [upsertAttributes](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.upsertattributes.md) - -## SavedObjectsIncrementCounterOptions.upsertAttributes property - -Attributes to use when upserting the document if it doesn't exist. - -Signature: - -```typescript -upsertAttributes?: Attributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md deleted file mode 100644 index ade286c8951d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmappingproperties.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) - -## SavedObjectsMappingProperties interface - -Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md). - -Signature: - -```typescript -export interface SavedObjectsMappingProperties -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md deleted file mode 100644 index 3c69d11880763..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) - -## SavedObjectsMigrationLogger.debug property - -Signature: - -```typescript -debug: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md deleted file mode 100644 index 16fbc8f4eaea3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) - -## SavedObjectsMigrationLogger.error property - -Signature: - -```typescript -error: (msg: string, meta: Meta) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md deleted file mode 100644 index 0dcb6b8889d4c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.info.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) - -## SavedObjectsMigrationLogger.info property - -Signature: - -```typescript -info: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md deleted file mode 100644 index 80f332c395159..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) - -## SavedObjectsMigrationLogger interface - - -Signature: - -```typescript -export interface SavedObjectsMigrationLogger -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) | (msg: string) => void | | -| [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) | <Meta extends LogMeta = LogMeta>(msg: string, meta: Meta) => void | | -| [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) | (msg: string) => void | | -| [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) | (msg: string) => void | | -| [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) | (msg: string) => void | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md deleted file mode 100644 index 34886e82d6d3d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) - -## SavedObjectsMigrationLogger.warn property - -Signature: - -```typescript -warn: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md deleted file mode 100644 index 5c37ce5aabcce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) > [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) - -## SavedObjectsMigrationLogger.warning property - -> Warning: This API is now obsolete. -> -> Use `warn` instead. 8.8.0 -> - -Signature: - -```typescript -warning: (msg: string) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md deleted file mode 100644 index 2241e71e4f8a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsmigrationversion.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsMigrationVersion](./kibana-plugin-core-server.savedobjectsmigrationversion.md) - -## SavedObjectsMigrationVersion interface - -Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. - -Signature: - -```typescript -export interface SavedObjectsMigrationVersion -``` - -## Example - -migrationVersion: { dashboard: '7.1.1', space: '6.6.6', } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md deleted file mode 100644 index 01a712aa89aa9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsnamespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsNamespaceType](./kibana-plugin-core-server.savedobjectsnamespacetype.md) - -## SavedObjectsNamespaceType type - -The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. \* multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be \*share-capable\*, but will not actually be shareable until the namespace type is changed to "multiple". \* agnostic: This type of saved object is global. - -Signature: - -```typescript -export declare type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md deleted file mode 100644 index 57752318cb96a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [keepAlive](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) - -## SavedObjectsOpenPointInTimeOptions.keepAlive property - -Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. - -Signature: - -```typescript -keepAlive?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md deleted file mode 100644 index 331fb6cbe0a6e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) - -## SavedObjectsOpenPointInTimeOptions interface - - -Signature: - -```typescript -export interface SavedObjectsOpenPointInTimeOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [keepAlive?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) | string | (Optional) Optionally specify how long ES should keep the PIT alive until the next request. Defaults to 5m. | -| [namespaces?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) | string\[\] | (Optional) An optional list of namespaces to be used when opening the PIT.When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - ['*'] will search across all available spaces | -| [preference?](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) | string | (Optional) An optional ES preference value to be used for the query. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md deleted file mode 100644 index 06fb7519d52c2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) - -## SavedObjectsOpenPointInTimeOptions.namespaces property - -An optional list of namespaces to be used when opening the PIT. - -When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - `['*']` will search across all available spaces - -Signature: - -```typescript -namespaces?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md deleted file mode 100644 index 7a9f3a49e8663..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) > [preference](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) - -## SavedObjectsOpenPointInTimeOptions.preference property - -An optional ES preference value to be used for the query. - -Signature: - -```typescript -preference?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md deleted file mode 100644 index 66387e5b3b89f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) > [id](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md) - -## SavedObjectsOpenPointInTimeResponse.id property - -PIT ID returned from ES. - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md deleted file mode 100644 index e3804d63a1e6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsOpenPointInTimeResponse](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.md) - -## SavedObjectsOpenPointInTimeResponse interface - - -Signature: - -```typescript -export interface SavedObjectsOpenPointInTimeResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsopenpointintimeresponse.id.md) | string | PIT ID returned from ES. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md deleted file mode 100644 index cb4d4a65727d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) > [id](./kibana-plugin-core-server.savedobjectspitparams.id.md) - -## SavedObjectsPitParams.id property - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md deleted file mode 100644 index 1011a908f210a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.keepalive.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) > [keepAlive](./kibana-plugin-core-server.savedobjectspitparams.keepalive.md) - -## SavedObjectsPitParams.keepAlive property - -Signature: - -```typescript -keepAlive?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md deleted file mode 100644 index 3109a6bd88f7e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectspitparams.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsPitParams](./kibana-plugin-core-server.savedobjectspitparams.md) - -## SavedObjectsPitParams interface - - -Signature: - -```typescript -export interface SavedObjectsPitParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectspitparams.id.md) | string | | -| [keepAlive?](./kibana-plugin-core-server.savedobjectspitparams.keepalive.md) | string | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md deleted file mode 100644 index 498069d4af471..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_id](./kibana-plugin-core-server.savedobjectsrawdoc._id.md) - -## SavedObjectsRawDoc.\_id property - -Signature: - -```typescript -_id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md deleted file mode 100644 index 6dc2eeb8a0c4c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_primary\_term](./kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md) - -## SavedObjectsRawDoc.\_primary\_term property - -Signature: - -```typescript -_primary_term?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md deleted file mode 100644 index 8b7016df7492b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_seq\_no](./kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md) - -## SavedObjectsRawDoc.\_seq\_no property - -Signature: - -```typescript -_seq_no?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md deleted file mode 100644 index 44faad2c8f990..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc._source.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) > [\_source](./kibana-plugin-core-server.savedobjectsrawdoc._source.md) - -## SavedObjectsRawDoc.\_source property - -Signature: - -```typescript -_source: SavedObjectsRawDocSource; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md deleted file mode 100644 index 8bce7fac941af..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdoc.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDoc](./kibana-plugin-core-server.savedobjectsrawdoc.md) - -## SavedObjectsRawDoc interface - -A raw document as represented directly in the saved object index. - -Signature: - -```typescript -export interface SavedObjectsRawDoc -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_id](./kibana-plugin-core-server.savedobjectsrawdoc._id.md) | string | | -| [\_primary\_term?](./kibana-plugin-core-server.savedobjectsrawdoc._primary_term.md) | number | (Optional) | -| [\_seq\_no?](./kibana-plugin-core-server.savedobjectsrawdoc._seq_no.md) | number | (Optional) | -| [\_source](./kibana-plugin-core-server.savedobjectsrawdoc._source.md) | SavedObjectsRawDocSource | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md deleted file mode 100644 index dc2166258d0c0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) - -## SavedObjectsRawDocParseOptions interface - -Options that can be specified when using the saved objects serializer to parse a raw document. - -Signature: - -```typescript -export interface SavedObjectsRawDocParseOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [namespaceTreatment?](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md) | 'strict' \| 'lax' | (Optional) Optional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously single-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade migrations.If not specified, the default treatment is strict. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md deleted file mode 100644 index c315d78aaf417..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRawDocParseOptions](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.md) > [namespaceTreatment](./kibana-plugin-core-server.savedobjectsrawdocparseoptions.namespacetreatment.md) - -## SavedObjectsRawDocParseOptions.namespaceTreatment property - -Optional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously single-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade migrations. - -If not specified, the default treatment is `strict`. - -Signature: - -```typescript -namespaceTreatment?: 'strict' | 'lax'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md deleted file mode 100644 index c10f74297305d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) - -## SavedObjectsRemoveReferencesToOptions interface - - -Signature: - -```typescript -export interface SavedObjectsRemoveReferencesToOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md) | boolean | (Optional) The Elasticsearch Refresh setting for this operation. Defaults to true | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md deleted file mode 100644 index 71e924a8af5e1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToOptions](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsremovereferencestooptions.refresh.md) - -## SavedObjectsRemoveReferencesToOptions.refresh property - -The Elasticsearch Refresh setting for this operation. Defaults to `true` - -Signature: - -```typescript -refresh?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md deleted file mode 100644 index cd10a9f916b03..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) - -## SavedObjectsRemoveReferencesToResponse interface - - -Signature: - -```typescript -export interface SavedObjectsRemoveReferencesToResponse extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [updated](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md) | number | The number of objects that have been updated by this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md deleted file mode 100644 index 67c3721ccdc68..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRemoveReferencesToResponse](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.md) > [updated](./kibana-plugin-core-server.savedobjectsremovereferencestoresponse.updated.md) - -## SavedObjectsRemoveReferencesToResponse.updated property - -The number of objects that have been updated by this operation - -Signature: - -```typescript -updated: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md deleted file mode 100644 index e71a9d266a3db..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkCreate](./kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md) - -## SavedObjectsRepository.bulkCreate() method - -Creates multiple documents at once - -Signature: - -```typescript -bulkCreate(objects: Array>, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkCreateObject<T>> | \[{ type, id, attributes, references, migrationVersion }\] | -| options | SavedObjectsCreateOptions | {boolean} \[options.overwrite=false\] - overwrites existing documents {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -{promise} - {saved\_objects: \[\[{ id, type, version, references, attributes, error: { message } }\]} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md deleted file mode 100644 index ab265132d606f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkget.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkGet](./kibana-plugin-core-server.savedobjectsrepository.bulkget.md) - -## SavedObjectsRepository.bulkGet() method - -Returns an array of objects by id - -Signature: - -```typescript -bulkGet(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkGetObject\[\] | an array of objects containing id, type and optionally fields | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResponse<T>> - -{promise} - { saved\_objects: \[{ id, type, version, attributes }\] } - -## Example - -bulkGet(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md deleted file mode 100644 index a67521753892d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkResolve](./kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md) - -## SavedObjectsRepository.bulkResolve() method - -Resolves an array of objects by id, using any legacy URL aliases if they exist - -Signature: - -```typescript -bulkResolve(objects: SavedObjectsBulkResolveObject[], options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsBulkResolveObject\[\] | an array of objects containing id, type | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsBulkResolveResponse<T>> - -{promise} - { resolved\_objects: \[{ saved\_object, outcome }\] } - -## Example - -bulkResolve(\[ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } \]) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md deleted file mode 100644 index c4244a8e34e3c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [bulkUpdate](./kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md) - -## SavedObjectsRepository.bulkUpdate() method - -Updates multiple objects in bulk - -Signature: - -```typescript -bulkUpdate(objects: Array>, options?: SavedObjectsBulkUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | Array<SavedObjectsBulkUpdateObject<T>> | \[{ type, id, attributes, options: { version, namespace } references }\] {string} options.version - ensures version matches that of persisted object {string} \[options.namespace\] | -| options | SavedObjectsBulkUpdateOptions | | - -Returns: - -Promise<SavedObjectsBulkUpdateResponse<T>> - -{promise} - {saved\_objects: \[\[{ id, type, version, references, attributes, error: { message } }\]} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md deleted file mode 100644 index 48adf6a2dba4a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [checkConflicts](./kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md) - -## SavedObjectsRepository.checkConflicts() method - -Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. - -Signature: - -```typescript -checkConflicts(objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCheckConflictsObject\[\] | | -| options | SavedObjectsBaseOptions | | - -Returns: - -Promise<SavedObjectsCheckConflictsResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md deleted file mode 100644 index e25cd9dfcaae7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.closepointintime.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [closePointInTime](./kibana-plugin-core-server.savedobjectsrepository.closepointintime.md) - -## SavedObjectsRepository.closePointInTime() method - -Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using `openPointInTimeForType`. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. - -Signature: - -```typescript -closePointInTime(id: string, options?: SavedObjectsClosePointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | -| options | SavedObjectsClosePointInTimeOptions | [SavedObjectsClosePointInTimeOptions](./kibana-plugin-core-server.savedobjectsclosepointintimeoptions.md) | - -Returns: - -Promise<SavedObjectsClosePointInTimeResponse> - -{promise} - [SavedObjectsClosePointInTimeResponse](./kibana-plugin-core-server.savedobjectsclosepointintimeresponse.md) - -## Remarks - -While the `keepAlive` that is provided will cause a PIT to automatically close, it is highly recommended to explicitly close a PIT when you are done with it in order to avoid consuming unneeded resources in Elasticsearch. - -## Example - - -```ts -const repository = coreStart.savedObjects.createInternalRepository(); - -const { id } = await repository.openPointInTimeForType( - type: 'index-pattern', - { keepAlive: '2m' }, -); - -const response = await repository.find({ - type: 'index-pattern', - search: 'foo*', - sortField: 'name', - sortOrder: 'desc', - pit: { - id: 'abc123', - keepAlive: '2m', - }, - searchAfter: [1234, 'abcd'], -}); - -await repository.closePointInTime(response.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md deleted file mode 100644 index b22b3bd8c0b53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [collectMultiNamespaceReferences](./kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md) - -## SavedObjectsRepository.collectMultiNamespaceReferences() method - -Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace type. - -Signature: - -```typescript -collectMultiNamespaceReferences(objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsCollectMultiNamespaceReferencesObject\[\] | The objects to get the references for. | -| options | SavedObjectsCollectMultiNamespaceReferencesOptions | | - -Returns: - -Promise<import("./collect\_multi\_namespace\_references").SavedObjectsCollectMultiNamespaceReferencesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md deleted file mode 100644 index 0c5412e2cd2df..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.create.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [create](./kibana-plugin-core-server.savedobjectsrepository.create.md) - -## SavedObjectsRepository.create() method - -Persists an object - -Signature: - -```typescript -create(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| attributes | T | | -| options | SavedObjectsCreateOptions | {string} \[options.id\] - force id on creation, not recommended {boolean} \[options.overwrite=false\] {object} \[options.migrationVersion=undefined\] {string} \[options.namespace\] {array} \[options.references=\[\]\] - \[{ name, type, id }\] | - -Returns: - -Promise<SavedObject<T>> - -{promise} - { id, type, version, attributes } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md deleted file mode 100644 index 4cbf51b85f26d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [createPointInTimeFinder](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) - -## SavedObjectsRepository.createPointInTimeFinder() method - -Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any `find` queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client. - -Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments. - -This generator wraps calls to [SavedObjectsRepository.find()](./kibana-plugin-core-server.savedobjectsrepository.find.md) and iterates over multiple pages of results using `_pit` and `search_after`. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated `perPage`. - -Once you have retrieved all of the results you need, it is recommended to call `close()` to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to `find` fails for any reason. - -Signature: - -```typescript -createPointInTimeFinder(findOptions: SavedObjectsCreatePointInTimeFinderOptions, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies): ISavedObjectsPointInTimeFinder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| findOptions | SavedObjectsCreatePointInTimeFinderOptions | | -| dependencies | SavedObjectsCreatePointInTimeFinderDependencies | | - -Returns: - -ISavedObjectsPointInTimeFinder<T, A> - -## Example - - -```ts -const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - type: 'visualization', - search: 'foo*', - perPage: 100, -}; - -const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - -const responses: SavedObjectFindResponse[] = []; -for await (const response of finder.find()) { - responses.push(...response); - if (doneSearching) { - await finder.close(); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md deleted file mode 100644 index 2caa59210b9d3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.delete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [delete](./kibana-plugin-core-server.savedobjectsrepository.delete.md) - -## SavedObjectsRepository.delete() method - -Deletes an object - -Signature: - -```typescript -delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsDeleteOptions | {string} \[options.namespace\] | - -Returns: - -Promise<{}> - -{promise} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md deleted file mode 100644 index 2e9048bcbe188..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [deleteByNamespace](./kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md) - -## SavedObjectsRepository.deleteByNamespace() method - -Deletes all objects from the provided namespace. - -Signature: - -```typescript -deleteByNamespace(namespace: string, options?: SavedObjectsDeleteByNamespaceOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string | | -| options | SavedObjectsDeleteByNamespaceOptions | | - -Returns: - -Promise<any> - -{promise} - { took, timed\_out, total, deleted, batches, version\_conflicts, noops, retries, failures } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md deleted file mode 100644 index 58c14917aa2c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.find.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [find](./kibana-plugin-core-server.savedobjectsrepository.find.md) - -## SavedObjectsRepository.find() method - -Signature: - -```typescript -find(options: SavedObjectsFindOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | SavedObjectsFindOptions | {(string\|Array)} \[options.type\] {string} \[options.search\] {string} \[options.defaultSearchOperator\] {Array} \[options.searchFields\] - see Elasticsearch Simple Query String Query field argument for more information {integer} \[options.page=1\] {integer} \[options.perPage=20\] {Array} \[options.searchAfter\] {string} \[options.sortField\] {string} \[options.sortOrder\] {Array} \[options.fields\] {string} \[options.namespace\] {object} \[options.hasReference\] - { type, id } {string} \[options.pit\] {string} \[options.preference\] | - -Returns: - -Promise<SavedObjectsFindResponse<T, A>> - -{promise} - { saved\_objects: \[{ id, type, version, attributes }\], total, per\_page, page } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md deleted file mode 100644 index 9f2b1b924857b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.get.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [get](./kibana-plugin-core-server.savedobjectsrepository.get.md) - -## SavedObjectsRepository.get() method - -Gets a single object - -Signature: - -```typescript -get(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObject<T>> - -{promise} - { id, type, version, attributes } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md deleted file mode 100644 index 0a51ec9429fe9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md +++ /dev/null @@ -1,69 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [incrementCounter](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) - -## SavedObjectsRepository.incrementCounter() method - -Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id. - -Signature: - -```typescript -incrementCounter(type: string, id: string, counterFields: Array, options?: SavedObjectsIncrementCounterOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | The type of saved object whose fields should be incremented | -| id | string | The id of the document whose fields should be incremented | -| counterFields | Array<string \| SavedObjectsIncrementCounterField> | An array of field names to increment or an array of [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) | -| options | SavedObjectsIncrementCounterOptions<T> | [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) | - -Returns: - -Promise<SavedObject<T>> - -The saved object after the specified fields were incremented - -## Remarks - -When supplying a field name like `stats.api.counter` the field name will be used as-is to create a document like: `{attributes: {'stats.api.counter': 1}}` It will not create a nested structure like: `{attributes: {stats: {api: {counter: 1}}}}` - -When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/main/src/plugins/usage\_collection/README.mdx\#tracking-interactions-with-incrementcounter) - -## Example - - -```ts -const repository = coreStart.savedObjects.createInternalRepository(); - -// Initialize all fields to 0 -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - 'stats.apiCalls', - 'stats.sampleDataInstalled', - ], {initialize: true}); - -// Increment the apiCalls field counter -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - 'stats.apiCalls', - ]) - -// Increment the apiCalls field counter by 4 -repository - .incrementCounter('dashboard_counter_type', 'counter_id', [ - { fieldName: 'stats.apiCalls' incrementBy: 4 }, - ]) - -// Initialize the document with arbitrary fields if not present -repository.incrementCounter<{ appId: string }>( - 'dashboard_counter_type', - 'counter_id', - [ 'stats.apiCalls'], - { upsertAttributes: { appId: 'myId' } } -) -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md deleted file mode 100644 index b1d65f5f6d3c3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) - -## SavedObjectsRepository class - - -Signature: - -```typescript -export declare class SavedObjectsRepository -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [bulkCreate(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkcreate.md) | | Creates multiple documents at once | -| [bulkGet(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkget.md) | | Returns an array of objects by id | -| [bulkResolve(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkresolve.md) | | Resolves an array of objects by id, using any legacy URL aliases if they exist | -| [bulkUpdate(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.bulkupdate.md) | | Updates multiple objects in bulk | -| [checkConflicts(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.checkconflicts.md) | | Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. | -| [closePointInTime(id, options)](./kibana-plugin-core-server.savedobjectsrepository.closepointintime.md) | | Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the Elasticsearch client, and is included in the Saved Objects Client as a convenience for consumers who are using openPointInTimeForType.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. | -| [collectMultiNamespaceReferences(objects, options)](./kibana-plugin-core-server.savedobjectsrepository.collectmultinamespacereferences.md) | | Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace type. | -| [create(type, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.create.md) | | Persists an object | -| [createPointInTimeFinder(findOptions, dependencies)](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) | | Returns a [ISavedObjectsPointInTimeFinder](./kibana-plugin-core-server.isavedobjectspointintimefinder.md) to help page through large sets of saved objects. We strongly recommend using this API for any find queries that might return more than 1000 saved objects, however this API is only intended for use in server-side "batch" processing of objects where you are collecting all objects in memory or streaming them back to the client.Do NOT use this API in a route handler to facilitate paging through saved objects on the client-side unless you are streaming all of the results back to the client at once. Because the returned generator is stateful, you cannot rely on subsequent http requests retrieving new pages from the same Kibana server in multi-instance deployments.This generator wraps calls to [SavedObjectsRepository.find()](./kibana-plugin-core-server.savedobjectsrepository.find.md) and iterates over multiple pages of results using _pit and search_after. This will open a new Point-In-Time (PIT), and continue paging until a set of results is received that's smaller than the designated perPage.Once you have retrieved all of the results you need, it is recommended to call close() to clean up the PIT and prevent Elasticsearch from consuming resources unnecessarily. This is only required if you are done iterating and have not yet paged through all of the results: the PIT will automatically be closed for you once you reach the last page of results, or if the underlying call to find fails for any reason. | -| [delete(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.delete.md) | | Deletes an object | -| [deleteByNamespace(namespace, options)](./kibana-plugin-core-server.savedobjectsrepository.deletebynamespace.md) | | Deletes all objects from the provided namespace. | -| [find(options)](./kibana-plugin-core-server.savedobjectsrepository.find.md) | | | -| [get(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.get.md) | | Gets a single object | -| [incrementCounter(type, id, counterFields, options)](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) | | Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id. | -| [openPointInTimeForType(type, { keepAlive, preference })](./kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md) | | Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned id can then be passed to SavedObjects.find to search against that PIT.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. | -| [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md) | | Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. | -| [resolve(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.resolve.md) | | Resolves a single object, using any legacy URL alias if it exists | -| [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.update.md) | | Updates an object | -| [updateObjectsSpaces(objects, spacesToAdd, spacesToRemove, options)](./kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md) | | Updates one or more objects to add and/or remove them from specified spaces. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md deleted file mode 100644 index e0eb4bc603a2d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [openPointInTimeForType](./kibana-plugin-core-server.savedobjectsrepository.openpointintimefortype.md) - -## SavedObjectsRepository.openPointInTimeForType() method - -Opens a Point In Time (PIT) against the indices for the specified Saved Object types. The returned `id` can then be passed to `SavedObjects.find` to search against that PIT. - -Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. - -Signature: - -```typescript -openPointInTimeForType(type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string \| string\[\] | | -| { keepAlive, preference } | SavedObjectsOpenPointInTimeOptions | | - -Returns: - -Promise<SavedObjectsOpenPointInTimeResponse> - -{promise} - { id: string } - -## Example - - -```ts -const { id } = await savedObjectsClient.openPointInTimeForType( - type: 'visualization', - { keepAlive: '5m' }, -); -const page1 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id, keepAlive: '2m' }, -}); -const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; -const page2 = await savedObjectsClient.find({ - type: 'visualization', - sortField: 'updated_at', - sortOrder: 'asc', - pit: { id: page1.pit_id }, - searchAfter: lastHit.sort, -}); -await savedObjectsClient.closePointInTime(page2.pit_id); -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md deleted file mode 100644 index 6691bf69e58dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [removeReferencesTo](./kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md) - -## SavedObjectsRepository.removeReferencesTo() method - -Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - -Signature: - -```typescript -removeReferencesTo(type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsRemoveReferencesToOptions | | - -Returns: - -Promise<SavedObjectsRemoveReferencesToResponse> - -## Remarks - -Will throw a conflict error if the `update_by_query` operation returns any failure. In that case some references might have been removed, and some were not. It is the caller's responsibility to handle and fix this situation if it was to happen. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md deleted file mode 100644 index bf558eca975fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.resolve.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [resolve](./kibana-plugin-core-server.savedobjectsrepository.resolve.md) - -## SavedObjectsRepository.resolve() method - -Resolves a single object, using any legacy URL alias if it exists - -Signature: - -```typescript -resolve(type: string, id: string, options?: SavedObjectsBaseOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| options | SavedObjectsBaseOptions | {string} \[options.namespace\] | - -Returns: - -Promise<SavedObjectsResolveResponse<T>> - -{promise} - { saved\_object, outcome } - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md deleted file mode 100644 index 681ba9eb3f014..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.update.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [update](./kibana-plugin-core-server.savedobjectsrepository.update.md) - -## SavedObjectsRepository.update() method - -Updates an object - -Signature: - -```typescript -update(type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | -| id | string | | -| attributes | Partial<T> | | -| options | SavedObjectsUpdateOptions<T> | {string} options.version - ensures version matches that of persisted object {string} \[options.namespace\] {array} \[options.references\] - \[{ name, type, id }\] | - -Returns: - -Promise<SavedObjectsUpdateResponse<T>> - -{promise} - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md deleted file mode 100644 index c226e8d2d2b1d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) > [updateObjectsSpaces](./kibana-plugin-core-server.savedobjectsrepository.updateobjectsspaces.md) - -## SavedObjectsRepository.updateObjectsSpaces() method - -Updates one or more objects to add and/or remove them from specified spaces. - -Signature: - -```typescript -updateObjectsSpaces(objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], spacesToRemove: string[], options?: SavedObjectsUpdateObjectsSpacesOptions): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objects | SavedObjectsUpdateObjectsSpacesObject\[\] | | -| spacesToAdd | string\[\] | | -| spacesToRemove | string\[\] | | -| options | SavedObjectsUpdateObjectsSpacesOptions | | - -Returns: - -Promise<import("./update\_objects\_spaces").SavedObjectsUpdateObjectsSpacesResponse> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md deleted file mode 100644 index e39ce020b930c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) > [createInternalRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md) - -## SavedObjectsRepositoryFactory.createInternalRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. - -Signature: - -```typescript -createInternalRepository: (includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md deleted file mode 100644 index 9cd0df9094277..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) > [createScopedRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md) - -## SavedObjectsRepositoryFactory.createScopedRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. - -Signature: - -```typescript -createScopedRepository: (req: KibanaRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md deleted file mode 100644 index 72aa79ed4df29..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepositoryfactory.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsRepositoryFactory](./kibana-plugin-core-server.savedobjectsrepositoryfactory.md) - -## SavedObjectsRepositoryFactory interface - -Factory provided when invoking a [client factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) See [SavedObjectsServiceSetup.setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) - -Signature: - -```typescript -export interface SavedObjectsRepositoryFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createInternalRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createinternalrepository.md) | (includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. | -| [createScopedRepository](./kibana-plugin-core-server.savedobjectsrepositoryfactory.createscopedrepository.md) | (req: KibanaRequest, includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md deleted file mode 100644 index 82831eae37d7b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [createNewCopies](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md) - -## SavedObjectsResolveImportErrorsOptions.createNewCopies property - -If true, will create new copies of import objects, each with a random `id` and undefined `originId`. - -Signature: - -```typescript -createNewCopies: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md deleted file mode 100644 index 7a005db4334ba..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) - -## SavedObjectsResolveImportErrorsOptions interface - -Options to control the "resolve import" operation. - -Signature: - -```typescript -export interface SavedObjectsResolveImportErrorsOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createNewCopies](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.createnewcopies.md) | boolean | If true, will create new copies of import objects, each with a random id and undefined originId. | -| [namespace?](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md) | string | (Optional) if specified, will import in given namespace | -| [readStream](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to resolve errors from | -| [retries](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md) | SavedObjectsImportRetry\[\] | saved object import references to retry | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md deleted file mode 100644 index 0ab9e02f9dfe5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [namespace](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.namespace.md) - -## SavedObjectsResolveImportErrorsOptions.namespace property - -if specified, will import in given namespace - -Signature: - -```typescript -namespace?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md deleted file mode 100644 index 8f5aa9bad3747..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [readStream](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.readstream.md) - -## SavedObjectsResolveImportErrorsOptions.readStream property - -The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to resolve errors from - -Signature: - -```typescript -readStream: Readable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md deleted file mode 100644 index 78b8cfdb72e3a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) > [retries](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.retries.md) - -## SavedObjectsResolveImportErrorsOptions.retries property - -saved object import references to retry - -Signature: - -```typescript -retries: SavedObjectsImportRetry[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md deleted file mode 100644 index afad46f9a84cd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [alias\_purpose](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md) - -## SavedObjectsResolveResponse.alias\_purpose property - -The reason this alias was created. - -Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md deleted file mode 100644 index 52419918c0831..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [alias\_target\_id](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md) - -## SavedObjectsResolveResponse.alias\_target\_id property - -The ID of the object that the legacy URL alias points to. - -\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - -Signature: - -```typescript -alias_target_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md deleted file mode 100644 index 0228c624f69d0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) - -## SavedObjectsResolveResponse interface - - -Signature: - -```typescript -export interface SavedObjectsResolveResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [alias\_purpose?](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_purpose.md) | 'savedObjectConversion' \| 'savedObjectImport' | (Optional) The reason this alias was created.Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [alias\_target\_id?](./kibana-plugin-core-server.savedobjectsresolveresponse.alias_target_id.md) | string | (Optional) The ID of the object that the legacy URL alias points to.\*\*Note:\*\* this field is \*only\* included when an alias was found (in other words, when the outcome is 'aliasMatch' or 'conflict'). | -| [outcome](./kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md) | 'exactMatch' \| 'aliasMatch' \| 'conflict' | The outcome for a successful resolve call is one of the following values:\* 'exactMatch' -- One document exactly matched the given ID. \* 'aliasMatch' -- One document with a legacy URL alias matched the given ID; in this case the saved_object.id field is different than the given ID. \* 'conflict' -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the saved_object object is the exact match, and the saved_object.id field is the same as the given ID. | -| [saved\_object](./kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md) | SavedObject<T> | The saved object that was found. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md deleted file mode 100644 index eadd85b175375..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [outcome](./kibana-plugin-core-server.savedobjectsresolveresponse.outcome.md) - -## SavedObjectsResolveResponse.outcome property - -The outcome for a successful `resolve` call is one of the following values: - -\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - -Signature: - -```typescript -outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md deleted file mode 100644 index c7748a2f97025..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsResolveResponse](./kibana-plugin-core-server.savedobjectsresolveresponse.md) > [saved\_object](./kibana-plugin-core-server.savedobjectsresolveresponse.saved_object.md) - -## SavedObjectsResolveResponse.saved\_object property - -The saved object that was found. - -Signature: - -```typescript -saved_object: SavedObject; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md deleted file mode 100644 index 6172a05d5c8fa..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [generateRawId](./kibana-plugin-core-server.savedobjectsserializer.generaterawid.md) - -## SavedObjectsSerializer.generateRawId() method - -Given a saved object type and id, generates the compound id that is stored in the raw document. - -Signature: - -```typescript -generateRawId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object | -| type | string | The saved object type | -| id | string | The id of the saved object | - -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md deleted file mode 100644 index 0f7c3dc22faf1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [generateRawLegacyUrlAliasId](./kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md) - -## SavedObjectsSerializer.generateRawLegacyUrlAliasId() method - -Given a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias. - -Signature: - -```typescript -generateRawLegacyUrlAliasId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object | -| type | string | The saved object type | -| id | string | The id of the saved object | - -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md deleted file mode 100644 index 00963e353aa20..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [isRawSavedObject](./kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md) - -## SavedObjectsSerializer.isRawSavedObject() method - -Determines whether or not the raw document can be converted to a saved object. - -Signature: - -```typescript -isRawSavedObject(doc: SavedObjectsRawDoc, options?: SavedObjectsRawDocParseOptions): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| doc | SavedObjectsRawDoc | The raw ES document to be tested | -| options | SavedObjectsRawDocParseOptions | Options for parsing the raw document. | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md deleted file mode 100644 index c7fa5fc85c613..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) - -## SavedObjectsSerializer class - -A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. - -Signature: - -```typescript -export declare class SavedObjectsSerializer -``` - -## Remarks - -Serializer instances should only be created and accessed by calling [SavedObjectsServiceStart.createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsSerializer` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [generateRawId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsserializer.generaterawid.md) | | Given a saved object type and id, generates the compound id that is stored in the raw document. | -| [generateRawLegacyUrlAliasId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsserializer.generaterawlegacyurlaliasid.md) | | Given a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias. | -| [isRawSavedObject(doc, options)](./kibana-plugin-core-server.savedobjectsserializer.israwsavedobject.md) | | Determines whether or not the raw document can be converted to a saved object. | -| [rawToSavedObject(doc, options)](./kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md) | | Converts a document from the format that is stored in elasticsearch to the saved object client format. | -| [savedObjectToRaw(savedObj)](./kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md) | | Converts a document from the saved object client format to the format that is stored in elasticsearch. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md deleted file mode 100644 index 9ac0ae0feee09..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [rawToSavedObject](./kibana-plugin-core-server.savedobjectsserializer.rawtosavedobject.md) - -## SavedObjectsSerializer.rawToSavedObject() method - -Converts a document from the format that is stored in elasticsearch to the saved object client format. - -Signature: - -```typescript -rawToSavedObject(doc: SavedObjectsRawDoc, options?: SavedObjectsRawDocParseOptions): SavedObjectSanitizedDoc; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| doc | SavedObjectsRawDoc | The raw ES document to be converted to saved object format. | -| options | SavedObjectsRawDocParseOptions | Options for parsing the raw document. | - -Returns: - -SavedObjectSanitizedDoc<T> - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md deleted file mode 100644 index 560011fc09638..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) > [savedObjectToRaw](./kibana-plugin-core-server.savedobjectsserializer.savedobjecttoraw.md) - -## SavedObjectsSerializer.savedObjectToRaw() method - -Converts a document from the saved object client format to the format that is stored in elasticsearch. - -Signature: - -```typescript -savedObjectToRaw(savedObj: SavedObjectSanitizedDoc): SavedObjectsRawDoc; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| savedObj | SavedObjectSanitizedDoc | The saved object to be converted to raw ES format. | - -Returns: - -SavedObjectsRawDoc - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md deleted file mode 100644 index 1c2a15a8b322e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [addClientWrapper](./kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) - -## SavedObjectsServiceSetup.addClientWrapper property - -Add a [client wrapper factory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) with the given priority. - -Signature: - -```typescript -addClientWrapper: (priority: number, id: string, factory: SavedObjectsClientWrapperFactory) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md deleted file mode 100644 index 9319ae987ad44..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [getKibanaIndex](./kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md) - -## SavedObjectsServiceSetup.getKibanaIndex property - -Returns the default index used for saved objects. - -Signature: - -```typescript -getKibanaIndex: () => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md deleted file mode 100644 index d9f7b888338fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.md +++ /dev/null @@ -1,56 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) - -## SavedObjectsServiceSetup interface - -Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. - -Signature: - -```typescript -export interface SavedObjectsServiceSetup -``` - -## Remarks - -When plugins access the Saved Objects client, a new client is created using the factory provided to `setClientFactory` and wrapped by all wrappers registered through `addClientWrapper`. - -## Example 1 - - -```ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.setClientFactory(({ request: KibanaRequest }) => { - return new SavedObjectsClient(core.savedObjects.scopedRepository(request)); - }) - } -} -``` - -## Example 2 - - -```ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; -import { mySoType } from './saved_objects' - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType(mySoType); - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addClientWrapper](./kibana-plugin-core-server.savedobjectsservicesetup.addclientwrapper.md) | (priority: number, id: string, factory: SavedObjectsClientWrapperFactory) => void | Add a [client wrapper factory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md) with the given priority. | -| [getKibanaIndex](./kibana-plugin-core-server.savedobjectsservicesetup.getkibanaindex.md) | () => string | Returns the default index used for saved objects. | -| [registerType](./kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) | <Attributes extends SavedObjectAttributes = any>(type: SavedObjectsType<Attributes>) => void | Register a [savedObjects type](./kibana-plugin-core-server.savedobjectstype.md) definition.See the [mappings format](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-core-server.savedobjectmigrationmap.md) for more details about these. | -| [setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) | (clientFactoryProvider: SavedObjectsClientFactoryProvider) => void | Set the default [factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) for creating Saved Objects clients. Only one provider can be set, subsequent calls to this method will fail. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md deleted file mode 100644 index afe3098ef1813..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.registertype.md +++ /dev/null @@ -1,60 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [registerType](./kibana-plugin-core-server.savedobjectsservicesetup.registertype.md) - -## SavedObjectsServiceSetup.registerType property - -Register a [savedObjects type](./kibana-plugin-core-server.savedobjectstype.md) definition. - -See the [mappings format](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) and [migration format](./kibana-plugin-core-server.savedobjectmigrationmap.md) for more details about these. - -Signature: - -```typescript -registerType: (type: SavedObjectsType) => void; -``` - -## Example - - -```ts -// src/plugins/my_plugin/server/saved_objects/my_type.ts -import { SavedObjectsType } from 'src/core/server'; -import * as migrations from './migrations'; -import * as schemas from './schemas'; - -export const myType: SavedObjectsType = { - name: 'MyType', - hidden: false, - namespaceType: 'multiple', - mappings: { - properties: { - textField: { - type: 'text', - }, - boolField: { - type: 'boolean', - }, - }, - }, - migrations: { - '2.0.0': migrations.migrateToV2, - '2.1.0': migrations.migrateToV2_1 - }, - schemas: { - '2.0.0': schemas.v2, - '2.1.0': schemas.v2_1, - }, -}; - -// src/plugins/my_plugin/server/plugin.ts -import { SavedObjectsClient, CoreSetup } from 'src/core/server'; -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType(myType); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md deleted file mode 100644 index e098245e369f1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) > [setClientFactoryProvider](./kibana-plugin-core-server.savedobjectsservicesetup.setclientfactoryprovider.md) - -## SavedObjectsServiceSetup.setClientFactoryProvider property - -Set the default [factory provider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md) for creating Saved Objects clients. Only one provider can be set, subsequent calls to this method will fail. - -Signature: - -```typescript -setClientFactoryProvider: (clientFactoryProvider: SavedObjectsClientFactoryProvider) => void; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md deleted file mode 100644 index 273d80983f15d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createexporter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createExporter](./kibana-plugin-core-server.savedobjectsservicestart.createexporter.md) - -## SavedObjectsServiceStart.createExporter property - -Creates an [exporter](./kibana-plugin-core-server.isavedobjectsexporter.md) bound to given client. - -Signature: - -```typescript -createExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md deleted file mode 100644 index f2617c5c6c12a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createimporter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createImporter](./kibana-plugin-core-server.savedobjectsservicestart.createimporter.md) - -## SavedObjectsServiceStart.createImporter property - -Creates an [importer](./kibana-plugin-core-server.isavedobjectsimporter.md) bound to given client. - -Signature: - -```typescript -createImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md deleted file mode 100644 index d03e9ca223c53..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md) - -## SavedObjectsServiceStart.createInternalRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. - -Signature: - -```typescript -createInternalRepository: (includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md deleted file mode 100644 index 762f77b98e74d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createScopedRepository](./kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md) - -## SavedObjectsServiceStart.createScopedRepository property - -Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. - -Signature: - -```typescript -createScopedRepository: (req: KibanaRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository; -``` - -## Remarks - -Prefer using `getScopedClient`. This should only be used when using methods not exposed on [SavedObjectsClientContract](./kibana-plugin-core-server.savedobjectsclientcontract.md) - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md deleted file mode 100644 index 434d6a0270ca3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.createserializer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) - -## SavedObjectsServiceStart.createSerializer property - -Creates a [serializer](./kibana-plugin-core-server.savedobjectsserializer.md) that is aware of all registered types. - -Signature: - -```typescript -createSerializer: () => SavedObjectsSerializer; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md deleted file mode 100644 index e4d3129ece549..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [getScopedClient](./kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) - -## SavedObjectsServiceStart.getScopedClient property - -Creates a [Saved Objects client](./kibana-plugin-core-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client. - -A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md). - -Signature: - -```typescript -getScopedClient: (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md deleted file mode 100644 index aac2f89b545d1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) > [getTypeRegistry](./kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md) - -## SavedObjectsServiceStart.getTypeRegistry property - -Returns the [registry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md) - -Signature: - -```typescript -getTypeRegistry: () => ISavedObjectTypeRegistry; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md deleted file mode 100644 index ae7480ab1e65b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsservicestart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) - -## SavedObjectsServiceStart interface - -Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. - -Signature: - -```typescript -export interface SavedObjectsServiceStart -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [createExporter](./kibana-plugin-core-server.savedobjectsservicestart.createexporter.md) | (client: SavedObjectsClientContract) => ISavedObjectsExporter | Creates an [exporter](./kibana-plugin-core-server.isavedobjectsexporter.md) bound to given client. | -| [createImporter](./kibana-plugin-core-server.savedobjectsservicestart.createimporter.md) | (client: SavedObjectsClientContract) => ISavedObjectsImporter | Creates an [importer](./kibana-plugin-core-server.isavedobjectsimporter.md) bound to given client. | -| [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md) | (includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. | -| [createScopedRepository](./kibana-plugin-core-server.savedobjectsservicestart.createscopedrepository.md) | (req: KibanaRequest, includedHiddenTypes?: string\[\]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-core-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. | -| [createSerializer](./kibana-plugin-core-server.savedobjectsservicestart.createserializer.md) | () => SavedObjectsSerializer | Creates a [serializer](./kibana-plugin-core-server.savedobjectsserializer.md) that is aware of all registered types. | -| [getScopedClient](./kibana-plugin-core-server.savedobjectsservicestart.getscopedclient.md) | (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract | Creates a [Saved Objects client](./kibana-plugin-core-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client.A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md). | -| [getTypeRegistry](./kibana-plugin-core-server.savedobjectsservicestart.gettyperegistry.md) | () => ISavedObjectTypeRegistry | Returns the [registry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) containing all registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md deleted file mode 100644 index 890ed36535b3f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) - -## SavedObjectStatusMeta interface - -Meta information about the SavedObjectService's status. Available to plugins via [CoreSetup.status](./kibana-plugin-core-server.coresetup.status.md). - -Signature: - -```typescript -export interface SavedObjectStatusMeta -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [migratedIndices](./kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md) | { \[status: string\]: number; skipped: number; migrated: number; } | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md deleted file mode 100644 index 6a29623b2f122..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectStatusMeta](./kibana-plugin-core-server.savedobjectstatusmeta.md) > [migratedIndices](./kibana-plugin-core-server.savedobjectstatusmeta.migratedindices.md) - -## SavedObjectStatusMeta.migratedIndices property - -Signature: - -```typescript -migratedIndices: { - [status: string]: number; - skipped: number; - migrated: number; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md deleted file mode 100644 index 296f7ba3044f6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [convertToAliasScript](./kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md) - -## SavedObjectsType.convertToAliasScript property - -If defined, will be used to convert the type to an alias. - -Signature: - -```typescript -convertToAliasScript?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md deleted file mode 100644 index a3fac34153633..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [convertToMultiNamespaceTypeVersion](./kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md) - -## SavedObjectsType.convertToMultiNamespaceTypeVersion property - -If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this version. - -Requirements: - -1. This string value must be a valid semver version 2. This type must have previously specified [\`namespaceType: 'single'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) 3. This type must also specify [\`namespaceType: 'multiple'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) \*or\* [\`namespaceType: 'multiple-isolated'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) - -Example of a single-namespace type in 7.12: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'single', - mappings: {...} -} -``` -Example after converting to a multi-namespace (isolated) type in 8.0: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple-isolated', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Example after converting to a multi-namespace (shareable) type in 8.1: - -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. - -Signature: - -```typescript -convertToMultiNamespaceTypeVersion?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md deleted file mode 100644 index f5446b37dc29c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [excludeOnUpgrade](./kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md) - -## SavedObjectsType.excludeOnUpgrade property - -If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. See [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) for more details. - -Signature: - -```typescript -excludeOnUpgrade?: SavedObjectTypeExcludeFromUpgradeFilterHook; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md deleted file mode 100644 index d13b9177394d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.hidden.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [hidden](./kibana-plugin-core-server.savedobjectstype.hidden.md) - -## SavedObjectsType.hidden property - -Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an `extraType` when creating the repository. - -See [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md). - -Signature: - -```typescript -hidden: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md deleted file mode 100644 index 8db74b9bfdec4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.indexpattern.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [indexPattern](./kibana-plugin-core-server.savedobjectstype.indexpattern.md) - -## SavedObjectsType.indexPattern property - -If defined, the type instances will be stored in the given index instead of the default one. - -Signature: - -```typescript -indexPattern?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md deleted file mode 100644 index d98c553656b1f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.management.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [management](./kibana-plugin-core-server.savedobjectstype.management.md) - -## SavedObjectsType.management property - -An optional [saved objects management section](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) definition for the type. - -Signature: - -```typescript -management?: SavedObjectsTypeManagementDefinition; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md deleted file mode 100644 index 066561b8c8633..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.mappings.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) - -## SavedObjectsType.mappings property - -The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. - -Signature: - -```typescript -mappings: SavedObjectsTypeMappingDefinition; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md deleted file mode 100644 index cd6e724685777..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) - -## SavedObjectsType interface - - -Signature: - -```typescript -export interface SavedObjectsType -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [convertToAliasScript?](./kibana-plugin-core-server.savedobjectstype.converttoaliasscript.md) | string | (Optional) If defined, will be used to convert the type to an alias. | -| [convertToMultiNamespaceTypeVersion?](./kibana-plugin-core-server.savedobjectstype.converttomultinamespacetypeversion.md) | string | (Optional) If defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this version.Requirements:1. This string value must be a valid semver version 2. This type must have previously specified [\`namespaceType: 'single'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) 3. This type must also specify [\`namespaceType: 'multiple'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md) \*or\* [\`namespaceType: 'multiple-isolated'\`](./kibana-plugin-core-server.savedobjectsnamespacetype.md)Example of a single-namespace type in 7.12: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'single', - mappings: {...} -} -``` -Example after converting to a multi-namespace (isolated) type in 8.0: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple-isolated', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Example after converting to a multi-namespace (shareable) type in 8.1: -```ts -{ - name: 'foo', - hidden: false, - namespaceType: 'multiple', - mappings: {...}, - convertToMultiNamespaceTypeVersion: '8.0.0' -} -``` -Note: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process. | -| [excludeOnUpgrade?](./kibana-plugin-core-server.savedobjectstype.excludeonupgrade.md) | SavedObjectTypeExcludeFromUpgradeFilterHook | (Optional) If defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted. See [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) for more details. | -| [hidden](./kibana-plugin-core-server.savedobjectstype.hidden.md) | boolean | Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an extraType when creating the repository.See [createInternalRepository](./kibana-plugin-core-server.savedobjectsservicestart.createinternalrepository.md). | -| [indexPattern?](./kibana-plugin-core-server.savedobjectstype.indexpattern.md) | string | (Optional) If defined, the type instances will be stored in the given index instead of the default one. | -| [management?](./kibana-plugin-core-server.savedobjectstype.management.md) | SavedObjectsTypeManagementDefinition<Attributes> | (Optional) An optional [saved objects management section](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) definition for the type. | -| [mappings](./kibana-plugin-core-server.savedobjectstype.mappings.md) | SavedObjectsTypeMappingDefinition | The [mapping definition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) for the type. | -| [migrations?](./kibana-plugin-core-server.savedobjectstype.migrations.md) | SavedObjectMigrationMap \| (() => SavedObjectMigrationMap) | (Optional) An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) or a function returning a map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. | -| [name](./kibana-plugin-core-server.savedobjectstype.name.md) | string | The name of the type, which is also used as the internal id. | -| [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) | SavedObjectsNamespaceType | The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. | -| [schemas?](./kibana-plugin-core-server.savedobjectstype.schemas.md) | SavedObjectsValidationMap \| (() => SavedObjectsValidationMap) | (Optional) An optional schema that can be used to validate the attributes of the type.When provided, calls to [create](./kibana-plugin-core-server.savedobjectsclient.create.md) will be validated against this schema.See [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) for more details. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md deleted file mode 100644 index 6550d48a1c26a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.migrations.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [migrations](./kibana-plugin-core-server.savedobjectstype.migrations.md) - -## SavedObjectsType.migrations property - -An optional map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) or a function returning a map of [migrations](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used to migrate the type. - -Signature: - -```typescript -migrations?: SavedObjectMigrationMap | (() => SavedObjectMigrationMap); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md deleted file mode 100644 index 4c63500498085..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [name](./kibana-plugin-core-server.savedobjectstype.name.md) - -## SavedObjectsType.name property - -The name of the type, which is also used as the internal id. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md deleted file mode 100644 index 3a3b0f7f3a9a5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.namespacetype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [namespaceType](./kibana-plugin-core-server.savedobjectstype.namespacetype.md) - -## SavedObjectsType.namespaceType property - -The [namespace type](./kibana-plugin-core-server.savedobjectsnamespacetype.md) for the type. - -Signature: - -```typescript -namespaceType: SavedObjectsNamespaceType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md deleted file mode 100644 index 466d8e361f995..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstype.schemas.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md) > [schemas](./kibana-plugin-core-server.savedobjectstype.schemas.md) - -## SavedObjectsType.schemas property - -An optional schema that can be used to validate the attributes of the type. - -When provided, calls to [create](./kibana-plugin-core-server.savedobjectsclient.create.md) will be validated against this schema. - -See [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) for more details. - -Signature: - -```typescript -schemas?: SavedObjectsValidationMap | (() => SavedObjectsValidationMap); -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md deleted file mode 100644 index d922a8daaac93..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [defaultSearchField](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) - -## SavedObjectsTypeManagementDefinition.defaultSearchField property - -The default search field to use for this type. Defaults to `id`. - -Signature: - -```typescript -defaultSearchField?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md deleted file mode 100644 index 71325318a68e6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [displayName](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md) - -## SavedObjectsTypeManagementDefinition.displayName property - -When specified, will be used instead of the type's name in SO management section's labels. - -Signature: - -```typescript -displayName?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md deleted file mode 100644 index 75f820d7a8e56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getEditUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md) - -## SavedObjectsTypeManagementDefinition.getEditUrl property - -Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. - -Signature: - -```typescript -getEditUrl?: (savedObject: SavedObject) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md deleted file mode 100644 index d6d50840aaadb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getInAppUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md) - -## SavedObjectsTypeManagementDefinition.getInAppUrl property - -Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. - -Signature: - -```typescript -getInAppUrl?: (savedObject: SavedObject) => { - path: string; - uiCapabilitiesPath: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md deleted file mode 100644 index 75784666ef963..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [getTitle](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) - -## SavedObjectsTypeManagementDefinition.getTitle property - -Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. - -Signature: - -```typescript -getTitle?: (savedObject: SavedObject) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md deleted file mode 100644 index d4bbea50b5692..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [icon](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md) - -## SavedObjectsTypeManagementDefinition.icon property - -The eui icon name to display in the management table. If not defined, the default icon will be used. - -Signature: - -```typescript -icon?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md deleted file mode 100644 index 9300f830e105b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [importableAndExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md) - -## SavedObjectsTypeManagementDefinition.importableAndExportable property - -Is the type importable or exportable. Defaults to `false`. - -Signature: - -```typescript -importableAndExportable?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md deleted file mode 100644 index c6dff60610990..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md +++ /dev/null @@ -1,48 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [isExportable](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md) - -## SavedObjectsTypeManagementDefinition.isExportable property - -Optional hook to specify whether an object should be exportable. - -If specified, `isExportable` will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export. - -When implementing both `isExportable` and `onExport`, it is mandatory that `isExportable` returns the same value for an object before and after going though the export transform. E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -Signature: - -```typescript -isExportable?: SavedObjectsExportablePredicate; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - -## Example - -Registering a type with a per-object exportability predicate - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - isExportable: (object) => { - if (object.attributes.myCustomAttr === 'foo') { - return false; - } - return true; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md deleted file mode 100644 index eeda40cd59664..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) - -## SavedObjectsTypeManagementDefinition interface - -Configuration options for the [type](./kibana-plugin-core-server.savedobjectstype.md)'s management section. - -Signature: - -```typescript -export interface SavedObjectsTypeManagementDefinition -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [defaultSearchField?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) | string | (Optional) The default search field to use for this type. Defaults to id. | -| [displayName?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md) | string | (Optional) When specified, will be used instead of the type's name in SO management section's labels. | -| [getEditUrl?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md) | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. | -| [getInAppUrl?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md) | (savedObject: SavedObject<Attributes>) => { path: string; uiCapabilitiesPath: string; } | (Optional) Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. | -| [getTitle?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) | (savedObject: SavedObject<Attributes>) => string | (Optional) Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. | -| [icon?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.icon.md) | string | (Optional) The eui icon name to display in the management table. If not defined, the default icon will be used. | -| [importableAndExportable?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.importableandexportable.md) | boolean | (Optional) Is the type importable or exportable. Defaults to false. | -| [isExportable?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.isexportable.md) | SavedObjectsExportablePredicate<Attributes> | (Optional) Optional hook to specify whether an object should be exportable.If specified, isExportable will be called during export for each of this type's objects in the export, and the ones not matching the predicate will be excluded from the export.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) | -| [onExport?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) | SavedObjectsExportTransform<Attributes> | (Optional) An optional export transform function that can be used transform the objects of the registered type during the export process.It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples.When implementing both isExportable and onExport, it is mandatory that isExportable returns the same value for an object before and after going though the export transform. E.g isExportable(objectBeforeTransform) === isExportable(objectAfterTransform) | -| [onImport?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) | SavedObjectsImportHook<Attributes> | (Optional) An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type.Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. | -| [visibleInManagement?](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md) | boolean | (Optional) When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to true. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md deleted file mode 100644 index a0d41d2d64967..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [onExport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onexport.md) - -## SavedObjectsTypeManagementDefinition.onExport property - -An optional export transform function that can be used transform the objects of the registered type during the export process. - -It can be used to either mutate the exported objects, or add additional objects (of any type) to the export list. - -See [the transform type documentation](./kibana-plugin-core-server.savedobjectsexporttransform.md) for more info and examples. - -When implementing both `isExportable` and `onExport`, it is mandatory that `isExportable` returns the same value for an object before and after going though the export transform. E.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)` - -Signature: - -```typescript -onExport?: SavedObjectsExportTransform; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md deleted file mode 100644 index c54570d79a7e2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [onImport](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.onimport.md) - -## SavedObjectsTypeManagementDefinition.onImport property - -An optional [import hook](./kibana-plugin-core-server.savedobjectsimporthook.md) to use when importing given type. - -Import hooks are executed during the savedObjects import process and allow to interact with the imported objects. See the [hook documentation](./kibana-plugin-core-server.savedobjectsimporthook.md) for more info. - -Signature: - -```typescript -onImport?: SavedObjectsImportHook; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - -## Example - -Registering a hook displaying a warning about a specific type of object - -```ts -// src/plugins/my_plugin/server/plugin.ts -import { myType } from './saved_objects'; - -export class Plugin() { - setup: (core: CoreSetup) => { - core.savedObjects.registerType({ - ...myType, - management: { - ...myType.management, - onImport: (objects) => { - if(someActionIsNeeded(objects)) { - return { - warnings: [ - { - type: 'action_required', - message: 'Objects need to be manually enabled after import', - actionPath: '/app/my-app/require-activation', - }, - ] - } - } - return {}; - } - }, - }); - } -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md deleted file mode 100644 index 33ddc8e8c8307..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) > [visibleInManagement](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.visibleinmanagement.md) - -## SavedObjectsTypeManagementDefinition.visibleInManagement property - -When set to false, the type will not be listed or searchable in the SO management section. Main usage of setting this property to false for a type is when objects from the type should be included in the export via references or export hooks, but should not directly appear in the SOM. Defaults to `true`. - -Signature: - -```typescript -visibleInManagement?: boolean; -``` - -## Remarks - -`importableAndExportable` must be `true` to specify this property. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md deleted file mode 100644 index 70775760ac77d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) > [dynamic](./kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md) - -## SavedObjectsTypeMappingDefinition.dynamic property - -The dynamic property of the mapping, either `false` or `'strict'`. If unspecified `dynamic: 'strict'` will be inherited from the top-level index mappings. - -Signature: - -```typescript -dynamic?: false | 'strict'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md deleted file mode 100644 index 7f4c82c23e2ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.md +++ /dev/null @@ -1,45 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) - -## SavedObjectsTypeMappingDefinition interface - -Describe a saved object type mapping. - -Signature: - -```typescript -export interface SavedObjectsTypeMappingDefinition -``` - -## Example - - -```ts -const typeDefinition: SavedObjectsTypeMappingDefinition = { - properties: { - enabled: { - type: "boolean" - }, - sendUsageFrom: { - ignore_above: 256, - type: "keyword" - }, - lastReported: { - type: "date" - }, - lastVersionChecked: { - ignore_above: 256, - type: "keyword" - }, - } -} -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [dynamic?](./kibana-plugin-core-server.savedobjectstypemappingdefinition.dynamic.md) | false \| 'strict' | (Optional) The dynamic property of the mapping, either false or 'strict'. If unspecified dynamic: 'strict' will be inherited from the top-level index mappings. | -| [properties](./kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md) | SavedObjectsMappingProperties | The underlying properties of the type mapping | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md deleted file mode 100644 index 6ccf2e2c90d0b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) > [properties](./kibana-plugin-core-server.savedobjectstypemappingdefinition.properties.md) - -## SavedObjectsTypeMappingDefinition.properties property - -The underlying properties of the type mapping - -Signature: - -```typescript -properties: SavedObjectsMappingProperties; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md deleted file mode 100644 index dac110ac4f475..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) > [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md) - -## SavedObjectsUpdateObjectsSpacesObject.id property - -The type of the object to update - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md deleted file mode 100644 index 6fa04623c96a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) - -## SavedObjectsUpdateObjectsSpacesObject interface - -An object that should have its spaces updated. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.id.md) | string | The type of the object to update | -| [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md) | string | The ID of the object to update | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md deleted file mode 100644 index 2e54d1636c5e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.md) > [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesobject.type.md) - -## SavedObjectsUpdateObjectsSpacesObject.type property - -The ID of the object to update - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md deleted file mode 100644 index b8f17699b1841..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) - -## SavedObjectsUpdateObjectsSpacesOptions interface - -Options for the update operation. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [refresh?](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md deleted file mode 100644 index 3d210f6ac51c7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesOptions](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesoptions.refresh.md) - -## SavedObjectsUpdateObjectsSpacesOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md deleted file mode 100644 index aff67e0c54e66..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) - -## SavedObjectsUpdateObjectsSpacesResponse interface - -The response when objects' spaces are updated. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [objects](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md) | SavedObjectsUpdateObjectsSpacesResponseObject\[\] | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md deleted file mode 100644 index 13328e2aed094..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponse](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.md) > [objects](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponse.objects.md) - -## SavedObjectsUpdateObjectsSpacesResponse.objects property - -Signature: - -```typescript -objects: SavedObjectsUpdateObjectsSpacesResponseObject[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md deleted file mode 100644 index 7d7ac4ada884d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [error](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.error property - -Included if there was an error updating this object's spaces - -Signature: - -```typescript -error?: SavedObjectError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md deleted file mode 100644 index 28a81ee5dfd6a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.id property - -The ID of the referenced object - -Signature: - -```typescript -id: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md deleted file mode 100644 index 5078473e9e6bd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject interface - -Details about a specific object's update result. - -Signature: - -```typescript -export interface SavedObjectsUpdateObjectsSpacesResponseObject -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error?](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.error.md) | SavedObjectError | (Optional) Included if there was an error updating this object's spaces | -| [id](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.id.md) | string | The ID of the referenced object | -| [spaces](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md) | string\[\] | The space(s) that the referenced object exists in | -| [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md) | string | The type of the referenced object | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md deleted file mode 100644 index 52b1ca187925c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [spaces](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.spaces.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.spaces property - -The space(s) that the referenced object exists in - -Signature: - -```typescript -spaces: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md deleted file mode 100644 index da0bbb1088507..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateObjectsSpacesResponseObject](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.md) > [type](./kibana-plugin-core-server.savedobjectsupdateobjectsspacesresponseobject.type.md) - -## SavedObjectsUpdateObjectsSpacesResponseObject.type property - -The type of the referenced object - -Signature: - -```typescript -type: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md deleted file mode 100644 index 7044f3007c382..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) - -## SavedObjectsUpdateOptions interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions -``` -Extends: SavedObjectsBaseOptions - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [references?](./kibana-plugin-core-server.savedobjectsupdateoptions.references.md) | SavedObjectReference\[\] | (Optional) A reference to another saved object. | -| [refresh?](./kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md) | MutatingOperationRefreshSetting | (Optional) The Elasticsearch Refresh setting for this operation | -| [retryOnConflict?](./kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md) | number | (Optional) The Elasticsearch retry_on_conflict setting for this operation. Defaults to 0 when version is provided, 3 otherwise. | -| [upsert?](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md) | Attributes | (Optional) If specified, will be used to perform an upsert if the document doesn't exist | -| [version?](./kibana-plugin-core-server.savedobjectsupdateoptions.version.md) | string | (Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md deleted file mode 100644 index 2cea0a7bdf0da..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.references.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [references](./kibana-plugin-core-server.savedobjectsupdateoptions.references.md) - -## SavedObjectsUpdateOptions.references property - -A reference to another saved object. - -Signature: - -```typescript -references?: SavedObjectReference[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md deleted file mode 100644 index 16ad763df46d2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsupdateoptions.refresh.md) - -## SavedObjectsUpdateOptions.refresh property - -The Elasticsearch Refresh setting for this operation - -Signature: - -```typescript -refresh?: MutatingOperationRefreshSetting; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md deleted file mode 100644 index 2fc54d0fb41ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [retryOnConflict](./kibana-plugin-core-server.savedobjectsupdateoptions.retryonconflict.md) - -## SavedObjectsUpdateOptions.retryOnConflict property - -The Elasticsearch `retry_on_conflict` setting for this operation. Defaults to `0` when `version` is provided, `3` otherwise. - -Signature: - -```typescript -retryOnConflict?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md deleted file mode 100644 index 53b769afd0938..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [upsert](./kibana-plugin-core-server.savedobjectsupdateoptions.upsert.md) - -## SavedObjectsUpdateOptions.upsert property - -If specified, will be used to perform an upsert if the document doesn't exist - -Signature: - -```typescript -upsert?: Attributes; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md deleted file mode 100644 index b92e517509c5c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateoptions.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) > [version](./kibana-plugin-core-server.savedobjectsupdateoptions.version.md) - -## SavedObjectsUpdateOptions.version property - -An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. - -Signature: - -```typescript -version?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md deleted file mode 100644 index df80e7ec56803..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) > [attributes](./kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md) - -## SavedObjectsUpdateResponse.attributes property - -Signature: - -```typescript -attributes: Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md deleted file mode 100644 index 5c773d92c6364..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) - -## SavedObjectsUpdateResponse interface - - -Signature: - -```typescript -export interface SavedObjectsUpdateResponse extends Omit, 'attributes' | 'references'> -``` -Extends: Omit<SavedObject<T>, 'attributes' \| 'references'> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [attributes](./kibana-plugin-core-server.savedobjectsupdateresponse.attributes.md) | Partial<T> | | -| [references](./kibana-plugin-core-server.savedobjectsupdateresponse.references.md) | SavedObjectReference\[\] \| undefined | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md deleted file mode 100644 index 262a4733e7beb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsupdateresponse.references.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) > [references](./kibana-plugin-core-server.savedobjectsupdateresponse.references.md) - -## SavedObjectsUpdateResponse.references property - -Signature: - -```typescript -references: SavedObjectReference[] | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md deleted file mode 100644 index 23cbebf22aa21..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [createEmptyFindResponse](./kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md) - -## SavedObjectsUtils.createEmptyFindResponse property - -Creates an empty response for a find operation. This is only intended to be used by saved objects client wrappers. - -Signature: - -```typescript -static createEmptyFindResponse: ({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md deleted file mode 100644 index 887f2fb5d9fe1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.generateid.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [generateId](./kibana-plugin-core-server.savedobjectsutils.generateid.md) - -## SavedObjectsUtils.generateId() method - -Generates a random ID for a saved objects. - -Signature: - -```typescript -static generateId(): string; -``` -Returns: - -string - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md deleted file mode 100644 index 502d9dcab8cf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [getConvertedObjectId](./kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md) - -## SavedObjectsUtils.getConvertedObjectId() method - -Uses a single-namespace object's "legacy ID" to determine what its new ID will be after it is converted to a multi-namespace type. - -Signature: - -```typescript -static getConvertedObjectId(namespace: string | undefined, type: string, id: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| namespace | string \| undefined | The namespace of the saved object before it is converted. | -| type | string | The type of the saved object before it is converted. | -| id | string | The ID of the saved object before it is converted. | - -Returns: - -string - -{string} The ID of the saved object after it is converted. - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md deleted file mode 100644 index 75db00c449654..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.israndomid.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [isRandomId](./kibana-plugin-core-server.savedobjectsutils.israndomid.md) - -## SavedObjectsUtils.isRandomId() method - -Validates that a saved object ID has been randomly generated. - -Signature: - -```typescript -static isRandomId(id: string | undefined): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string \| undefined | The ID of a saved object. Use uuid.validate once upgraded to v5.3+ | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md deleted file mode 100644 index 9a8c5cf9889b2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) - -## SavedObjectsUtils class - - -Signature: - -```typescript -export declare class SavedObjectsUtils -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [createEmptyFindResponse](./kibana-plugin-core-server.savedobjectsutils.createemptyfindresponse.md) | static | <T, A>({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse<T, A> | Creates an empty response for a find operation. This is only intended to be used by saved objects client wrappers. | -| [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md) | static | (namespace?: string \| undefined) => string | Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the undefined namespace ID (which has a namespace string of 'default'). | -| [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md) | static | (namespace: string) => string \| undefined | Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the 'default' namespace string (which has a namespace ID of undefined). | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [generateId()](./kibana-plugin-core-server.savedobjectsutils.generateid.md) | static | Generates a random ID for a saved objects. | -| [getConvertedObjectId(namespace, type, id)](./kibana-plugin-core-server.savedobjectsutils.getconvertedobjectid.md) | static | Uses a single-namespace object's "legacy ID" to determine what its new ID will be after it is converted to a multi-namespace type. | -| [isRandomId(id)](./kibana-plugin-core-server.savedobjectsutils.israndomid.md) | static | Validates that a saved object ID has been randomly generated. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md deleted file mode 100644 index 591505892e64f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md) - -## SavedObjectsUtils.namespaceIdToString property - -Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the `undefined` namespace ID (which has a namespace string of `'default'`). - -Signature: - -```typescript -static namespaceIdToString: (namespace?: string | undefined) => string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md deleted file mode 100644 index e052fe493b5ea..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) > [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md) - -## SavedObjectsUtils.namespaceStringToId property - -Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the `'default'` namespace string (which has a namespace ID of `undefined`). - -Signature: - -```typescript -static namespaceStringToId: (namespace: string) => string | undefined; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md deleted file mode 100644 index 3716db5c3d9ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationmap.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsValidationMap](./kibana-plugin-core-server.savedobjectsvalidationmap.md) - -## SavedObjectsValidationMap interface - -A map of [validation specs](./kibana-plugin-core-server.savedobjectsvalidationspec.md) to be used for a given type. The map's keys must be valid semver versions. - -Any time you change the schema of a [SavedObjectsType](./kibana-plugin-core-server.savedobjectstype.md), you should add a new entry to this map for the Kibana version the change was introduced in. - -Signature: - -```typescript -export interface SavedObjectsValidationMap -``` - -## Example - - -```typescript -const validationMap: SavedObjectsValidationMap = { - '1.0.0': schema.object({ - foo: schema.string(), - }), - '2.0.0': schema.object({ - foo: schema.string({ - minLength: 2, - validate(value) { - if (!/^[a-z]+$/.test(value)) { - return 'must be lowercase letters only'; - } - } - }), - }), -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md deleted file mode 100644 index 55938fb4b4b6c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsvalidationspec.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsValidationSpec](./kibana-plugin-core-server.savedobjectsvalidationspec.md) - -## SavedObjectsValidationSpec type - -Allows for validating properties using @kbn/config-schema validations. - -Signature: - -```typescript -export declare type SavedObjectsValidationSpec = ObjectType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md deleted file mode 100644 index bd1c43529895c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeExcludeFromUpgradeFilterHook](./kibana-plugin-core-server.savedobjecttypeexcludefromupgradefilterhook.md) - -## SavedObjectTypeExcludeFromUpgradeFilterHook type - -If defined, allows a type to run a search query and return a query filter that may match any documents which may be excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which are no longer needed and may slow the migration process. - -If this hook fails, the migration will proceed without these documents having been filtered out, so this should not be used as a guarantee that these documents have been deleted. - -Experimental and subject to change - -Signature: - -```typescript -export declare type SavedObjectTypeExcludeFromUpgradeFilterHook = (toolkit: { - readonlyEsClient: Pick; -}) => estypes.QueryDslQueryContainer | Promise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md deleted file mode 100644 index 7e4733f892955..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getAllTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md) - -## SavedObjectTypeRegistry.getAllTypes() method - -Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered, including the hidden ones. - -To only get the visible types (which is the most common use case), use `getVisibleTypes` instead. - -Signature: - -```typescript -getAllTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md deleted file mode 100644 index a20360128406a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getImportableAndExportableTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md) - -## SavedObjectTypeRegistry.getImportableAndExportableTypes() method - -Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered that are importable/exportable. - -Signature: - -```typescript -getImportableAndExportableTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md deleted file mode 100644 index 9da28c7f01278..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getindex.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getIndex](./kibana-plugin-core-server.savedobjecttyperegistry.getindex.md) - -## SavedObjectTypeRegistry.getIndex() method - -Returns the `indexPattern` property for given type, or `undefined` if the type is not registered. - -Signature: - -```typescript -getIndex(type: string): string | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -string \| undefined - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md deleted file mode 100644 index d6fc255958c8c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.gettype.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getType](./kibana-plugin-core-server.savedobjecttyperegistry.gettype.md) - -## SavedObjectTypeRegistry.getType() method - -Return the [type](./kibana-plugin-core-server.savedobjectstype.md) definition for given type name. - -Signature: - -```typescript -getType(type: string): SavedObjectsType | undefined; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -SavedObjectsType<any> \| undefined - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md deleted file mode 100644 index 9588e77e646fc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [getVisibleTypes](./kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md) - -## SavedObjectTypeRegistry.getVisibleTypes() method - -Returns all visible [types](./kibana-plugin-core-server.savedobjectstype.md). - -A visible type is a type that doesn't explicitly define `hidden=true` during registration. - -Signature: - -```typescript -getVisibleTypes(): SavedObjectsType[]; -``` -Returns: - -SavedObjectsType<any>\[\] - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md deleted file mode 100644 index 2d29e753218d7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isHidden](./kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md) - -## SavedObjectTypeRegistry.isHidden() method - -Returns the `hidden` property for given type, or `false` if the type is not registered. - -Signature: - -```typescript -isHidden(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md deleted file mode 100644 index 8487af6a58911..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isImportableAndExportable](./kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md) - -## SavedObjectTypeRegistry.isImportableAndExportable() method - -Returns the `management.importableAndExportable` property for given type, or `false` if the type is not registered or does not define a management section. - -Signature: - -```typescript -isImportableAndExportable(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md deleted file mode 100644 index d4ec6de2392dd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isMultiNamespace](./kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md) - -## SavedObjectTypeRegistry.isMultiNamespace() method - -Returns whether the type is multi-namespace (shareable \*or\* isolated); resolves to `false` if the type is not registered - -Signature: - -```typescript -isMultiNamespace(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md deleted file mode 100644 index d6eca4981f7ab..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isNamespaceAgnostic](./kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md) - -## SavedObjectTypeRegistry.isNamespaceAgnostic() method - -Returns whether the type is namespace-agnostic (global); resolves to `false` if the type is not registered - -Signature: - -```typescript -isNamespaceAgnostic(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md deleted file mode 100644 index 0b67992e53080..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isShareable](./kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md) - -## SavedObjectTypeRegistry.isShareable() method - -Returns whether the type is multi-namespace (shareable); resolves to `false` if the type is not registered - -Signature: - -```typescript -isShareable(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md deleted file mode 100644 index d1db00d0c8162..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [isSingleNamespace](./kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md) - -## SavedObjectTypeRegistry.isSingleNamespace() method - -Returns whether the type is single-namespace (isolated); resolves to `true` if the type is not registered - -Signature: - -```typescript -isSingleNamespace(type: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | string | | - -Returns: - -boolean - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md deleted file mode 100644 index 0f2de8c8ef9b3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) - -## SavedObjectTypeRegistry class - -Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md). - -Signature: - -```typescript -export declare class SavedObjectTypeRegistry -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [getAllTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getalltypes.md) | | Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered, including the hidden ones.To only get the visible types (which is the most common use case), use getVisibleTypes instead. | -| [getImportableAndExportableTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getimportableandexportabletypes.md) | | Return all [types](./kibana-plugin-core-server.savedobjectstype.md) currently registered that are importable/exportable. | -| [getIndex(type)](./kibana-plugin-core-server.savedobjecttyperegistry.getindex.md) | | Returns the indexPattern property for given type, or undefined if the type is not registered. | -| [getType(type)](./kibana-plugin-core-server.savedobjecttyperegistry.gettype.md) | | Return the [type](./kibana-plugin-core-server.savedobjectstype.md) definition for given type name. | -| [getVisibleTypes()](./kibana-plugin-core-server.savedobjecttyperegistry.getvisibletypes.md) | | Returns all visible [types](./kibana-plugin-core-server.savedobjectstype.md).A visible type is a type that doesn't explicitly define hidden=true during registration. | -| [isHidden(type)](./kibana-plugin-core-server.savedobjecttyperegistry.ishidden.md) | | Returns the hidden property for given type, or false if the type is not registered. | -| [isImportableAndExportable(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isimportableandexportable.md) | | Returns the management.importableAndExportable property for given type, or false if the type is not registered or does not define a management section. | -| [isMultiNamespace(type)](./kibana-plugin-core-server.savedobjecttyperegistry.ismultinamespace.md) | | Returns whether the type is multi-namespace (shareable \*or\* isolated); resolves to false if the type is not registered | -| [isNamespaceAgnostic(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isnamespaceagnostic.md) | | Returns whether the type is namespace-agnostic (global); resolves to false if the type is not registered | -| [isShareable(type)](./kibana-plugin-core-server.savedobjecttyperegistry.isshareable.md) | | Returns whether the type is multi-namespace (shareable); resolves to false if the type is not registered | -| [isSingleNamespace(type)](./kibana-plugin-core-server.savedobjecttyperegistry.issinglenamespace.md) | | Returns whether the type is single-namespace (isolated); resolves to true if the type is not registered | -| [registerType(type)](./kibana-plugin-core-server.savedobjecttyperegistry.registertype.md) | | Register a [type](./kibana-plugin-core-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md b/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md deleted file mode 100644 index c0442e2aaa4ce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjecttyperegistry.registertype.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) > [registerType](./kibana-plugin-core-server.savedobjecttyperegistry.registertype.md) - -## SavedObjectTypeRegistry.registerType() method - -Register a [type](./kibana-plugin-core-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. - -Signature: - -```typescript -registerType(type: SavedObjectsType): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | SavedObjectsType | | - -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md deleted file mode 100644 index 8e2395ee6310d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectUnsanitizedDoc](./kibana-plugin-core-server.savedobjectunsanitizeddoc.md) - -## SavedObjectUnsanitizedDoc type - -Describes Saved Object documents from Kibana < 7.0.0 which don't have a `references` root property defined. This type should only be used in migrations. - -Signature: - -```typescript -export declare type SavedObjectUnsanitizedDoc = SavedObjectDoc & Partial; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md b/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md deleted file mode 100644 index f8f05823ae81f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.scopeablerequest.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ScopeableRequest](./kibana-plugin-core-server.scopeablerequest.md) - -## ScopeableRequest type - -A user credentials container. It accommodates the necessary auth credentials to impersonate the current user. - -See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md). - -Signature: - -```typescript -export declare type ScopeableRequest = KibanaRequest | FakeRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md deleted file mode 100644 index a9dd0e76475fd..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [\_scroll\_id](./kibana-plugin-core-server.searchresponse._scroll_id.md) - -## SearchResponse.\_scroll\_id property - -Signature: - -```typescript -_scroll_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md deleted file mode 100644 index e090ad20e8bc8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [\_shards](./kibana-plugin-core-server.searchresponse._shards.md) - -## SearchResponse.\_shards property - -Signature: - -```typescript -_shards: ShardsResponse; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md deleted file mode 100644 index 686e6f2aa05e9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [aggregations](./kibana-plugin-core-server.searchresponse.aggregations.md) - -## SearchResponse.aggregations property - -Signature: - -```typescript -aggregations?: any; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md deleted file mode 100644 index 599c4e3ad6319..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [hits](./kibana-plugin-core-server.searchresponse.hits.md) - -## SearchResponse.hits property - -Signature: - -```typescript -hits: { - total: number; - max_score: number; - hits: Array<{ - _index: string; - _type: string; - _id: string; - _score: number; - _source: T; - _version?: number; - _explanation?: Explanation; - fields?: any; - highlight?: any; - inner_hits?: any; - matched_queries?: string[]; - sort?: unknown[]; - }>; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.md deleted file mode 100644 index 7deca96e4054c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) - -## SearchResponse interface - - -Signature: - -```typescript -export interface SearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [\_scroll\_id?](./kibana-plugin-core-server.searchresponse._scroll_id.md) | string | (Optional) | -| [\_shards](./kibana-plugin-core-server.searchresponse._shards.md) | ShardsResponse | | -| [aggregations?](./kibana-plugin-core-server.searchresponse.aggregations.md) | any | (Optional) | -| [hits](./kibana-plugin-core-server.searchresponse.hits.md) | { total: number; max\_score: number; hits: Array<{ \_index: string; \_type: string; \_id: string; \_score: number; \_source: T; \_version?: number; \_explanation?: Explanation; fields?: any; highlight?: any; inner\_hits?: any; matched\_queries?: string\[\]; sort?: unknown\[\]; }>; } | | -| [pit\_id?](./kibana-plugin-core-server.searchresponse.pit_id.md) | string | (Optional) | -| [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md) | boolean | | -| [took](./kibana-plugin-core-server.searchresponse.took.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md deleted file mode 100644 index f214bc0538045..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.pit_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [pit\_id](./kibana-plugin-core-server.searchresponse.pit_id.md) - -## SearchResponse.pit\_id property - -Signature: - -```typescript -pit_id?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md deleted file mode 100644 index a3488117cd874..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md) - -## SearchResponse.timed\_out property - -Signature: - -```typescript -timed_out: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md b/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md deleted file mode 100644 index 8c9c0b0f7c420..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SearchResponse](./kibana-plugin-core-server.searchresponse.md) > [took](./kibana-plugin-core-server.searchresponse.took.md) - -## SearchResponse.took property - -Signature: - -```typescript -took: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md deleted file mode 100644 index fa369aa0bdfbb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.detail.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [detail](./kibana-plugin-core-server.servicestatus.detail.md) - -## ServiceStatus.detail property - -A more detailed description of the service status. - -Signature: - -```typescript -detail?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md deleted file mode 100644 index 5ef8c1251a602..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.documentationurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [documentationUrl](./kibana-plugin-core-server.servicestatus.documentationurl.md) - -## ServiceStatus.documentationUrl property - -A URL to open in a new tab about how to resolve or troubleshoot the problem. - -Signature: - -```typescript -documentationUrl?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md deleted file mode 100644 index 551c10c9bff82..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [level](./kibana-plugin-core-server.servicestatus.level.md) - -## ServiceStatus.level property - -The current availability level of the service. - -Signature: - -```typescript -level: ServiceStatusLevel; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.md deleted file mode 100644 index 5c04cb33a7529..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) - -## ServiceStatus interface - -The current status of a service at a point in time. - -Signature: - -```typescript -export interface ServiceStatus | unknown = unknown> -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [detail?](./kibana-plugin-core-server.servicestatus.detail.md) | string | (Optional) A more detailed description of the service status. | -| [documentationUrl?](./kibana-plugin-core-server.servicestatus.documentationurl.md) | string | (Optional) A URL to open in a new tab about how to resolve or troubleshoot the problem. | -| [level](./kibana-plugin-core-server.servicestatus.level.md) | ServiceStatusLevel | The current availability level of the service. | -| [meta?](./kibana-plugin-core-server.servicestatus.meta.md) | Meta | (Optional) Any JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained, machine-readable information about the service status. May include status information for underlying features. | -| [summary](./kibana-plugin-core-server.servicestatus.summary.md) | string | A high-level summary of the service status. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md deleted file mode 100644 index a48994daa5a4e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.meta.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [meta](./kibana-plugin-core-server.servicestatus.meta.md) - -## ServiceStatus.meta property - -Any JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained, machine-readable information about the service status. May include status information for underlying features. - -Signature: - -```typescript -meta?: Meta; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md b/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md deleted file mode 100644 index db90afd6f74a6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatus.summary.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) > [summary](./kibana-plugin-core-server.servicestatus.summary.md) - -## ServiceStatus.summary property - -A high-level summary of the service status. - -Signature: - -```typescript -summary: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md b/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md deleted file mode 100644 index 5f995ff5e13e3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatusLevel](./kibana-plugin-core-server.servicestatuslevel.md) - -## ServiceStatusLevel type - -A convenience type that represents the union of each value in [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md). - -Signature: - -```typescript -export declare type ServiceStatusLevel = typeof ServiceStatusLevels[keyof typeof ServiceStatusLevels]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md b/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md deleted file mode 100644 index e57dc192cd572..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.servicestatuslevels.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md) - -## ServiceStatusLevels variable - -The current "level" of availability of a service. - -Signature: - -```typescript -ServiceStatusLevels: Readonly<{ - available: Readonly<{ - toString: () => "available"; - valueOf: () => 0; - toJSON: () => "available"; - }>; - degraded: Readonly<{ - toString: () => "degraded"; - valueOf: () => 1; - toJSON: () => "degraded"; - }>; - unavailable: Readonly<{ - toString: () => "unavailable"; - valueOf: () => 2; - toJSON: () => "unavailable"; - }>; - critical: Readonly<{ - toString: () => "critical"; - valueOf: () => 3; - toJSON: () => "critical"; - }>; -}> -``` - -## Remarks - -The values implement `valueOf` to allow for easy comparisons between status levels with <, >, etc. Higher values represent higher severities. Note that the default `Array.prototype.sort` implementation does not correctly sort these values. - -A snapshot serializer is available in `src/core/server/test_utils` to ease testing of these values with Jest. - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md deleted file mode 100644 index c9132b9692318..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) > [isValid](./kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md) - -## SessionCookieValidationResult.isValid property - -Whether the cookie is valid or not. - -Signature: - -```typescript -isValid: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md deleted file mode 100644 index 6c1a5e7af78a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) - -## SessionCookieValidationResult interface - -Return type from a function to validate cookie contents. - -Signature: - -```typescript -export interface SessionCookieValidationResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isValid](./kibana-plugin-core-server.sessioncookievalidationresult.isvalid.md) | boolean | Whether the cookie is valid or not. | -| [path?](./kibana-plugin-core-server.sessioncookievalidationresult.path.md) | string | (Optional) The "Path" attribute of the cookie; if the cookie is invalid, this is used to clear it. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md b/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md deleted file mode 100644 index 59b6cb7ca6e6b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessioncookievalidationresult.path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) > [path](./kibana-plugin-core-server.sessioncookievalidationresult.path.md) - -## SessionCookieValidationResult.path property - -The "Path" attribute of the cookie; if the cookie is invalid, this is used to clear it. - -Signature: - -```typescript -path?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md deleted file mode 100644 index ac34c9b17be8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.clear.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [clear](./kibana-plugin-core-server.sessionstorage.clear.md) - -## SessionStorage.clear() method - -Clears current session. - -Signature: - -```typescript -clear(): void; -``` -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md deleted file mode 100644 index 9e867b9e0fcc8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.get.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [get](./kibana-plugin-core-server.sessionstorage.get.md) - -## SessionStorage.get() method - -Retrieves session value from the session storage. - -Signature: - -```typescript -get(): Promise; -``` -Returns: - -Promise<T \| null> - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md deleted file mode 100644 index e6ddef20c22a4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) - -## SessionStorage interface - -Provides an interface to store and retrieve data across requests. - -Signature: - -```typescript -export interface SessionStorage -``` - -## Methods - -| Method | Description | -| --- | --- | -| [clear()](./kibana-plugin-core-server.sessionstorage.clear.md) | Clears current session. | -| [get()](./kibana-plugin-core-server.sessionstorage.get.md) | Retrieves session value from the session storage. | -| [set(sessionValue)](./kibana-plugin-core-server.sessionstorage.set.md) | Puts current session value into the session storage. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md b/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md deleted file mode 100644 index a17aadf8fb984..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstorage.set.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) > [set](./kibana-plugin-core-server.sessionstorage.set.md) - -## SessionStorage.set() method - -Puts current session value into the session storage. - -Signature: - -```typescript -set(sessionValue: T): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sessionValue | T | value to put | - -Returns: - -void - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md deleted file mode 100644 index 377ce19b31601..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [encryptionKey](./kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md) - -## SessionStorageCookieOptions.encryptionKey property - -A key used to encrypt a cookie's value. Should be at least 32 characters long. - -Signature: - -```typescript -encryptionKey: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md deleted file mode 100644 index fc401fa99b83c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [isSecure](./kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md) - -## SessionStorageCookieOptions.isSecure property - -Flag indicating whether the cookie should be sent only via a secure connection. - -Signature: - -```typescript -isSecure: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md deleted file mode 100644 index 425daf32f5cb3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) - -## SessionStorageCookieOptions interface - -Configuration used to create HTTP session storage based on top of cookie mechanism. - -Signature: - -```typescript -export interface SessionStorageCookieOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [encryptionKey](./kibana-plugin-core-server.sessionstoragecookieoptions.encryptionkey.md) | string | A key used to encrypt a cookie's value. Should be at least 32 characters long. | -| [isSecure](./kibana-plugin-core-server.sessionstoragecookieoptions.issecure.md) | boolean | Flag indicating whether the cookie should be sent only via a secure connection. | -| [name](./kibana-plugin-core-server.sessionstoragecookieoptions.name.md) | string | Name of the session cookie. | -| [sameSite?](./kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md) | 'Strict' \| 'Lax' \| 'None' | (Optional) Defines SameSite attribute of the Set-Cookie Header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite | -| [validate](./kibana-plugin-core-server.sessionstoragecookieoptions.validate.md) | (sessionValue: T \| T\[\]) => SessionCookieValidationResult | Function called to validate a cookie's decrypted value. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md deleted file mode 100644 index 47c1926415221..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [name](./kibana-plugin-core-server.sessionstoragecookieoptions.name.md) - -## SessionStorageCookieOptions.name property - -Name of the session cookie. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md deleted file mode 100644 index a2bf79a52d521..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [sameSite](./kibana-plugin-core-server.sessionstoragecookieoptions.samesite.md) - -## SessionStorageCookieOptions.sameSite property - -Defines SameSite attribute of the Set-Cookie Header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite - -Signature: - -```typescript -sameSite?: 'Strict' | 'Lax' | 'None'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md deleted file mode 100644 index 2626c94f6afb1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragecookieoptions.validate.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) > [validate](./kibana-plugin-core-server.sessionstoragecookieoptions.validate.md) - -## SessionStorageCookieOptions.validate property - -Function called to validate a cookie's decrypted value. - -Signature: - -```typescript -validate: (sessionValue: T | T[]) => SessionCookieValidationResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md deleted file mode 100644 index be3c997a0aa71..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.asscoped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) > [asScoped](./kibana-plugin-core-server.sessionstoragefactory.asscoped.md) - -## SessionStorageFactory.asScoped property - -Signature: - -```typescript -asScoped: (request: KibanaRequest) => SessionStorage; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md b/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md deleted file mode 100644 index 7bdea28beeda1..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sessionstoragefactory.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) - -## SessionStorageFactory interface - -SessionStorage factory to bind one to an incoming request - -Signature: - -```typescript -export interface SessionStorageFactory -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [asScoped](./kibana-plugin-core-server.sessionstoragefactory.asscoped.md) | (request: KibanaRequest) => SessionStorage<T> | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md deleted file mode 100644 index a47fc1263be41..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [failed](./kibana-plugin-core-server.shardsinfo.failed.md) - -## ShardsInfo.failed property - -Signature: - -```typescript -failed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md deleted file mode 100644 index 6c006c020d3fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) - -## ShardsInfo interface - - -Signature: - -```typescript -export interface ShardsInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [failed](./kibana-plugin-core-server.shardsinfo.failed.md) | number | | -| [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md) | number | | -| [successful](./kibana-plugin-core-server.shardsinfo.successful.md) | number | | -| [total](./kibana-plugin-core-server.shardsinfo.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md deleted file mode 100644 index 0c87831edd6ca..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md) - -## ShardsInfo.skipped property - -Signature: - -```typescript -skipped: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md deleted file mode 100644 index c927adb39932a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [successful](./kibana-plugin-core-server.shardsinfo.successful.md) - -## ShardsInfo.successful property - -Signature: - -```typescript -successful: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md b/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md deleted file mode 100644 index 820c8a70fd222..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) > [total](./kibana-plugin-core-server.shardsinfo.total.md) - -## ShardsInfo.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md deleted file mode 100644 index 7f7a173af2e58..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [failed](./kibana-plugin-core-server.shardsresponse.failed.md) - -## ShardsResponse.failed property - -Signature: - -```typescript -failed: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md deleted file mode 100644 index 65e113f05212f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) - -## ShardsResponse interface - - -Signature: - -```typescript -export interface ShardsResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [failed](./kibana-plugin-core-server.shardsresponse.failed.md) | number | | -| [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md) | number | | -| [successful](./kibana-plugin-core-server.shardsresponse.successful.md) | number | | -| [total](./kibana-plugin-core-server.shardsresponse.total.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md deleted file mode 100644 index b01c3501fe022..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md) - -## ShardsResponse.skipped property - -Signature: - -```typescript -skipped: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md deleted file mode 100644 index 23c6ff0519ed7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [successful](./kibana-plugin-core-server.shardsresponse.successful.md) - -## ShardsResponse.successful property - -Signature: - -```typescript -successful: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md b/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md deleted file mode 100644 index e669f6216a10f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) > [total](./kibana-plugin-core-server.shardsresponse.total.md) - -## ShardsResponse.total property - -Signature: - -```typescript -total: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md b/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md deleted file mode 100644 index 477cd5a651a56..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.sharedglobalconfig.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SharedGlobalConfig](./kibana-plugin-core-server.sharedglobalconfig.md) - -## SharedGlobalConfig type - - -Signature: - -```typescript -export declare type SharedGlobalConfig = RecursiveReadonly<{ - elasticsearch: Pick; - path: Pick; - savedObjects: Pick; -}>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md b/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md deleted file mode 100644 index 7f90060d3ffa8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.startservicesaccessor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) - -## StartServicesAccessor type - -Allows plugins to get access to APIs available in start inside async handlers. Promise will not resolve until Core and plugin dependencies have completed `start`. This should only be used inside handlers registered during `setup` that will only be executed after `start` lifecycle. - -Signature: - -```typescript -export declare type StartServicesAccessor = () => Promise<[CoreStart, TPluginsStart, TStart]>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md deleted file mode 100644 index 6662e68b44d36..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.core_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [core$](./kibana-plugin-core-server.statusservicesetup.core_.md) - -## StatusServiceSetup.core$ property - -Current status for all Core services. - -Signature: - -```typescript -core$: Observable; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md deleted file mode 100644 index 7475f0e3a4c1c..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.dependencies_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md) - -## StatusServiceSetup.dependencies$ property - -Current status for all plugins this plugin depends on. Each key of the `Record` is a plugin id. - -Signature: - -```typescript -dependencies$: Observable>; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md deleted file mode 100644 index 96784359457fb..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.derivedstatus_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) - -## StatusServiceSetup.derivedStatus$ property - -The status of this plugin as derived from its dependencies. - -Signature: - -```typescript -derivedStatus$: Observable; -``` - -## Remarks - -By default, plugins inherit this derived status from their dependencies. Calling overrides this default status. - -This may emit multiple times for a single status change event as propagates through the dependency tree - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md deleted file mode 100644 index c417aaa2cef48..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [isStatusPageAnonymous](./kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md) - -## StatusServiceSetup.isStatusPageAnonymous property - -Whether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is present. - -Signature: - -```typescript -isStatusPageAnonymous: () => boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md deleted file mode 100644 index 5409772c369c2..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.md +++ /dev/null @@ -1,83 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) - -## StatusServiceSetup interface - -API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status. - -Signature: - -```typescript -export interface StatusServiceSetup -``` - -## Remarks - -By default, a plugin inherits it's current status from the most severe status level of any Core services and any plugins that it depends on. This default status is available on the API. - -Plugins may customize their status calculation by calling the API with an Observable. Within this Observable, a plugin may choose to only depend on the status of some of its dependencies, to ignore severe status levels of particular Core services they are not concerned with, or to make its status dependent on other external services. - -## Example 1 - -Customize a plugin's status to only depend on the status of SavedObjects: - -```ts -core.status.set( - core.status.core$.pipe( -. map((coreStatus) => { - return coreStatus.savedObjects; - }) ; - ); -); -``` - -## Example 2 - -Customize a plugin's status to include an external service: - -```ts -const externalStatus$ = interval(1000).pipe( - switchMap(async () => { - const resp = await fetch(`https://myexternaldep.com/_healthz`); - const body = await resp.json(); - if (body.ok) { - return of({ level: ServiceStatusLevels.available, summary: 'External Service is up'}); - } else { - return of({ level: ServiceStatusLevels.available, summary: 'External Service is unavailable'}); - } - }), - catchError((error) => { - of({ level: ServiceStatusLevels.unavailable, summary: `External Service is down`, meta: { error }}) - }) -); - -core.status.set( - combineLatest([core.status.derivedStatus$, externalStatus$]).pipe( - map(([derivedStatus, externalStatus]) => { - if (externalStatus.level > derivedStatus) { - return externalStatus; - } else { - return derivedStatus; - } - }) - ) -); -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [core$](./kibana-plugin-core-server.statusservicesetup.core_.md) | Observable<CoreStatus> | Current status for all Core services. | -| [dependencies$](./kibana-plugin-core-server.statusservicesetup.dependencies_.md) | Observable<Record<string, ServiceStatus>> | Current status for all plugins this plugin depends on. Each key of the Record is a plugin id. | -| [derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) | Observable<ServiceStatus> | The status of this plugin as derived from its dependencies. | -| [isStatusPageAnonymous](./kibana-plugin-core-server.statusservicesetup.isstatuspageanonymous.md) | () => boolean | Whether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is present. | -| [overall$](./kibana-plugin-core-server.statusservicesetup.overall_.md) | Observable<ServiceStatus> | Overall system status for all of Kibana. | - -## Methods - -| Method | Description | -| --- | --- | -| [set(status$)](./kibana-plugin-core-server.statusservicesetup.set.md) | Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md deleted file mode 100644 index bb7c31311d520..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.overall_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [overall$](./kibana-plugin-core-server.statusservicesetup.overall_.md) - -## StatusServiceSetup.overall$ property - -Overall system status for all of Kibana. - -Signature: - -```typescript -overall$: Observable; -``` - -## Remarks - -The level of the overall status will reflect the most severe status of any core service or plugin. - -Exposed only for reporting purposes to outside systems and should not be used by plugins. Instead, plugins should only depend on the statuses of [Core](./kibana-plugin-core-server.statusservicesetup.core_.md) or their dependencies. - diff --git a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md b/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md deleted file mode 100644 index b60319e19529a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.statusservicesetup.set.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) > [set](./kibana-plugin-core-server.statusservicesetup.set.md) - -## StatusServiceSetup.set() method - -Allows a plugin to specify a custom status dependent on its own criteria. Completely overrides the default inherited status. - -Signature: - -```typescript -set(status$: Observable): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| status$ | Observable<ServiceStatus> | | - -Returns: - -void - -## Remarks - -The first emission from this Observable should occur within 30s, else this plugin's status will fallback to `unavailable` until the first emission. - -See the [StatusServiceSetup.derivedStatus$](./kibana-plugin-core-server.statusservicesetup.derivedstatus_.md) API for leveraging the default status calculation that is provided by Core. - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md deleted file mode 100644 index 224df5f073eb7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [category](./kibana-plugin-core-server.uisettingsparams.category.md) - -## UiSettingsParams.category property - -used to group the configured setting in the UI - -Signature: - -```typescript -category?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md deleted file mode 100644 index 0be426d609606..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.deprecation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [deprecation](./kibana-plugin-core-server.uisettingsparams.deprecation.md) - -## UiSettingsParams.deprecation property - -optional deprecation information. Used to generate a deprecation warning. - -Signature: - -```typescript -deprecation?: DeprecationSettings; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md deleted file mode 100644 index 5ba8244e6cfb4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [description](./kibana-plugin-core-server.uisettingsparams.description.md) - -## UiSettingsParams.description property - -description provided to a user in UI - -Signature: - -```typescript -description?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md deleted file mode 100644 index 531a0e75c97b0..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) - -## UiSettingsParams interface - -UiSettings parameters defined by the plugins. - -Signature: - -```typescript -export interface UiSettingsParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./kibana-plugin-core-server.uisettingsparams.category.md) | string\[\] | (Optional) used to group the configured setting in the UI | -| [deprecation?](./kibana-plugin-core-server.uisettingsparams.deprecation.md) | DeprecationSettings | (Optional) optional deprecation information. Used to generate a deprecation warning. | -| [description?](./kibana-plugin-core-server.uisettingsparams.description.md) | string | (Optional) description provided to a user in UI | -| [metric?](./kibana-plugin-core-server.uisettingsparams.metric.md) | { type: UiCounterMetricType; name: string; } | (Optional) Metric to track once this property changes | -| [name?](./kibana-plugin-core-server.uisettingsparams.name.md) | string | (Optional) title in the UI | -| [optionLabels?](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) | Record<string, string> | (Optional) text labels for 'select' type UI element | -| [options?](./kibana-plugin-core-server.uisettingsparams.options.md) | string\[\] | (Optional) array of permitted values for this setting | -| [order?](./kibana-plugin-core-server.uisettingsparams.order.md) | number | (Optional) index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. settings without order defined will be displayed last and ordered by name | -| [readonly?](./kibana-plugin-core-server.uisettingsparams.readonly.md) | boolean | (Optional) a flag indicating that value cannot be changed | -| [requiresPageReload?](./kibana-plugin-core-server.uisettingsparams.requirespagereload.md) | boolean | (Optional) a flag indicating whether new value applying requires page reloading | -| [schema](./kibana-plugin-core-server.uisettingsparams.schema.md) | Type<T> | | -| [sensitive?](./kibana-plugin-core-server.uisettingsparams.sensitive.md) | boolean | (Optional) a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. | -| [type?](./kibana-plugin-core-server.uisettingsparams.type.md) | UiSettingsType | (Optional) defines a type of UI element [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) | -| [value?](./kibana-plugin-core-server.uisettingsparams.value.md) | T | (Optional) default value to fall back to if a user doesn't provide any | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md deleted file mode 100644 index 8491de9a8f5dc..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.metric.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) - -## UiSettingsParams.metric property - -> Warning: This API is now obsolete. -> -> Temporary measure until https://github.com/elastic/kibana/issues/83084 is in place -> - -Metric to track once this property changes - -Signature: - -```typescript -metric?: { - type: UiCounterMetricType; - name: string; - }; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md deleted file mode 100644 index 248498c232c9f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [name](./kibana-plugin-core-server.uisettingsparams.name.md) - -## UiSettingsParams.name property - -title in the UI - -Signature: - -```typescript -name?: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md deleted file mode 100644 index 97a66e71fb846..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.optionlabels.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [optionLabels](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) - -## UiSettingsParams.optionLabels property - -text labels for 'select' type UI element - -Signature: - -```typescript -optionLabels?: Record; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md deleted file mode 100644 index 94eff9f0a0146..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [options](./kibana-plugin-core-server.uisettingsparams.options.md) - -## UiSettingsParams.options property - -array of permitted values for this setting - -Signature: - -```typescript -options?: string[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md deleted file mode 100644 index 140bdad5d786b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.order.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [order](./kibana-plugin-core-server.uisettingsparams.order.md) - -## UiSettingsParams.order property - -index of the settings within its category (ascending order, smallest will be displayed first). Used for ordering in the UI. - - settings without order defined will be displayed last and ordered by name - -Signature: - -```typescript -order?: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md deleted file mode 100644 index b9342eff345c9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.readonly.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [readonly](./kibana-plugin-core-server.uisettingsparams.readonly.md) - -## UiSettingsParams.readonly property - -a flag indicating that value cannot be changed - -Signature: - -```typescript -readonly?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md deleted file mode 100644 index 46bfa291857d4..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.requirespagereload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [requiresPageReload](./kibana-plugin-core-server.uisettingsparams.requirespagereload.md) - -## UiSettingsParams.requiresPageReload property - -a flag indicating whether new value applying requires page reloading - -Signature: - -```typescript -requiresPageReload?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md deleted file mode 100644 index f181fbd309b7f..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.schema.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [schema](./kibana-plugin-core-server.uisettingsparams.schema.md) - -## UiSettingsParams.schema property - -Signature: - -```typescript -schema: Type; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md deleted file mode 100644 index f2c7de19dde1a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.sensitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [sensitive](./kibana-plugin-core-server.uisettingsparams.sensitive.md) - -## UiSettingsParams.sensitive property - -a flag indicating that value might contain user sensitive data. used by telemetry to mask the value of the setting when sent. - -Signature: - -```typescript -sensitive?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md deleted file mode 100644 index 9d663f05713c6..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [type](./kibana-plugin-core-server.uisettingsparams.type.md) - -## UiSettingsParams.type property - -defines a type of UI element [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) - -Signature: - -```typescript -type?: UiSettingsType; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md deleted file mode 100644 index 78c8f0c8fcf8d..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsparams.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsParams](./kibana-plugin-core-server.uisettingsparams.md) > [value](./kibana-plugin-core-server.uisettingsparams.value.md) - -## UiSettingsParams.value property - -default value to fall back to if a user doesn't provide any - -Signature: - -```typescript -value?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md deleted file mode 100644 index 97b711bca303a..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) - -## UiSettingsServiceSetup interface - - -Signature: - -```typescript -export interface UiSettingsServiceSetup -``` - -## Methods - -| Method | Description | -| --- | --- | -| [register(settings)](./kibana-plugin-core-server.uisettingsservicesetup.register.md) | Sets settings with default values for the uiSettings. | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md deleted file mode 100644 index 97b06ddb00e70..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicesetup.register.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) > [register](./kibana-plugin-core-server.uisettingsservicesetup.register.md) - -## UiSettingsServiceSetup.register() method - -Sets settings with default values for the uiSettings. - -Signature: - -```typescript -register(settings: Record): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| settings | Record<string, UiSettingsParams> | | - -Returns: - -void - -## Example - - -```ts -setup(core: CoreSetup){ - core.uiSettings.register([{ - foo: { - name: i18n.translate('my foo settings'), - value: true, - description: 'add some awesomeness', - }, - }]); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md deleted file mode 100644 index 1d76bc26a4150..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) > [asScopedToClient](./kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md) - -## UiSettingsServiceStart.asScopedToClient() method - -Creates a [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) with provided \*scoped\* saved objects client. - -This should only be used in the specific case where the client needs to be accessed from outside of the scope of a [RequestHandler](./kibana-plugin-core-server.requesthandler.md). - -Signature: - -```typescript -asScopedToClient(savedObjectsClient: SavedObjectsClientContract): IUiSettingsClient; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| savedObjectsClient | SavedObjectsClientContract | | - -Returns: - -IUiSettingsClient - -## Example - - -```ts -start(core: CoreStart) { - const soClient = core.savedObjects.getScopedClient(arbitraryRequest); - const uiSettingsClient = core.uiSettings.asScopedToClient(soClient); -} -``` - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md b/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md deleted file mode 100644 index 014f7d533b2ff..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingsservicestart.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) - -## UiSettingsServiceStart interface - - -Signature: - -```typescript -export interface UiSettingsServiceStart -``` - -## Methods - -| Method | Description | -| --- | --- | -| [asScopedToClient(savedObjectsClient)](./kibana-plugin-core-server.uisettingsservicestart.asscopedtoclient.md) | Creates a [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) with provided \*scoped\* saved objects client.This should only be used in the specific case where the client needs to be accessed from outside of the scope of a [RequestHandler](./kibana-plugin-core-server.requesthandler.md). | - diff --git a/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md b/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md deleted file mode 100644 index 7edee442baa24..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.uisettingstype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) - -## UiSettingsType type - -UI element type to represent the settings. - -Signature: - -```typescript -export declare type UiSettingsType = 'undefined' | 'json' | 'markdown' | 'number' | 'select' | 'boolean' | 'string' | 'array' | 'image' | 'color'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md deleted file mode 100644 index a79d62ab7f3c7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederror.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedError](./kibana-plugin-core-server.unauthorizederror.md) - -## UnauthorizedError type - - -Signature: - -```typescript -export declare type UnauthorizedError = errors.ResponseError & { - statusCode: 401; -}; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md deleted file mode 100644 index 10c6253619217..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandler.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) - -## UnauthorizedErrorHandler type - -A handler used to handle unauthorized error returned by elasticsearch - -Signature: - -```typescript -export declare type UnauthorizedErrorHandler = (options: UnauthorizedErrorHandlerOptions, toolkit: UnauthorizedErrorHandlerToolkit) => MaybePromise; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md deleted file mode 100644 index 2300d53816e07..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) - -## UnauthorizedErrorHandlerNotHandledResult interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerNotHandledResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md) | 'notHandled' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md deleted file mode 100644 index 9a8fc62517bce..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerNotHandledResult](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.md) > [type](./kibana-plugin-core-server.unauthorizederrorhandlernothandledresult.type.md) - -## UnauthorizedErrorHandlerNotHandledResult.type property - -Signature: - -```typescript -type: 'notHandled'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md deleted file mode 100644 index b3b355dfdc97e..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) > [error](./kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md) - -## UnauthorizedErrorHandlerOptions.error property - -Signature: - -```typescript -error: UnauthorizedError; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md deleted file mode 100644 index efaf5109568be..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) - -## UnauthorizedErrorHandlerOptions interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [error](./kibana-plugin-core-server.unauthorizederrorhandleroptions.error.md) | UnauthorizedError | | -| [request](./kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md) | KibanaRequest | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md deleted file mode 100644 index 94a0970844615..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerOptions](./kibana-plugin-core-server.unauthorizederrorhandleroptions.md) > [request](./kibana-plugin-core-server.unauthorizederrorhandleroptions.request.md) - -## UnauthorizedErrorHandlerOptions.request property - -Signature: - -```typescript -request: KibanaRequest; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md deleted file mode 100644 index fb5d8ad7d35c5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresult.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResult](./kibana-plugin-core-server.unauthorizederrorhandlerresult.md) - -## UnauthorizedErrorHandlerResult type - - -Signature: - -```typescript -export declare type UnauthorizedErrorHandlerResult = UnauthorizedErrorHandlerRetryResult | UnauthorizedErrorHandlerNotHandledResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md deleted file mode 100644 index f6a8cb3d5b613..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) > [authHeaders](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md) - -## UnauthorizedErrorHandlerResultRetryParams.authHeaders property - -Signature: - -```typescript -authHeaders: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md deleted file mode 100644 index d9c8e4c0733a7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerResultRetryParams](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.md) - -## UnauthorizedErrorHandlerResultRetryParams interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerResultRetryParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authHeaders](./kibana-plugin-core-server.unauthorizederrorhandlerresultretryparams.authheaders.md) | AuthHeaders | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md deleted file mode 100644 index 09d7f08229be3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) - -## UnauthorizedErrorHandlerRetryResult interface - - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerRetryResult extends UnauthorizedErrorHandlerResultRetryParams -``` -Extends: UnauthorizedErrorHandlerResultRetryParams - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md) | 'retry' | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md deleted file mode 100644 index 64d1e9270682b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerRetryResult](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.md) > [type](./kibana-plugin-core-server.unauthorizederrorhandlerretryresult.type.md) - -## UnauthorizedErrorHandlerRetryResult.type property - -Signature: - -```typescript -type: 'retry'; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md deleted file mode 100644 index f28dae053b351..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) - -## UnauthorizedErrorHandlerToolkit interface - -Toolkit passed to a [UnauthorizedErrorHandler](./kibana-plugin-core-server.unauthorizederrorhandler.md) used to generate responses from the handler - -Signature: - -```typescript -export interface UnauthorizedErrorHandlerToolkit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [notHandled](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md) | () => UnauthorizedErrorHandlerNotHandledResult | The handler cannot handle the error, or was not able to authenticate. | -| [retry](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md) | (params: UnauthorizedErrorHandlerResultRetryParams) => UnauthorizedErrorHandlerRetryResult | The handler was able to authenticate. Will retry the failed request with new auth headers | - diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md deleted file mode 100644 index 76fc3dd48ff74..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) > [notHandled](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.nothandled.md) - -## UnauthorizedErrorHandlerToolkit.notHandled property - -The handler cannot handle the error, or was not able to authenticate. - -Signature: - -```typescript -notHandled: () => UnauthorizedErrorHandlerNotHandledResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md b/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md deleted file mode 100644 index 6a5e5c78414ac..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UnauthorizedErrorHandlerToolkit](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.md) > [retry](./kibana-plugin-core-server.unauthorizederrorhandlertoolkit.retry.md) - -## UnauthorizedErrorHandlerToolkit.retry property - -The handler was able to authenticate. Will retry the failed request with new auth headers - -Signature: - -```typescript -retry: (params: UnauthorizedErrorHandlerResultRetryParams) => UnauthorizedErrorHandlerRetryResult; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md deleted file mode 100644 index 12fc1af0d6ae9..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.isoverridden.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) > [isOverridden](./kibana-plugin-core-server.userprovidedvalues.isoverridden.md) - -## UserProvidedValues.isOverridden property - -Signature: - -```typescript -isOverridden?: boolean; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md deleted file mode 100644 index fe8aaf233fbf7..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) - -## UserProvidedValues interface - -Describes the values explicitly set by user. - -Signature: - -```typescript -export interface UserProvidedValues -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isOverridden?](./kibana-plugin-core-server.userprovidedvalues.isoverridden.md) | boolean | (Optional) | -| [userValue?](./kibana-plugin-core-server.userprovidedvalues.uservalue.md) | T | (Optional) | - diff --git a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md b/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md deleted file mode 100644 index 6840f66d6f9f3..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.userprovidedvalues.uservalue.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) > [userValue](./kibana-plugin-core-server.userprovidedvalues.uservalue.md) - -## UserProvidedValues.userValue property - -Signature: - -```typescript -userValue?: T; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md b/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md deleted file mode 100644 index 97d6a42602ab5..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.validbodyoutput.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [validBodyOutput](./kibana-plugin-core-server.validbodyoutput.md) - -## validBodyOutput variable - -The set of valid body.output - -Signature: - -```typescript -validBodyOutput: readonly ["data", "stream"] -``` diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 2aa160674b744..120617ea4de94 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -215,7 +215,7 @@ When enabled, provides access to the experimental *Labs* features for *Canvas*. [[labs-dashboard-defer-below-fold]]`labs:dashboard:deferBelowFold`:: When enabled, the panels that appear below the fold are loaded when they become visible on the dashboard. -_Below the fold_ refers to panels that are not immediately visible when you open a dashboard, but become visible as you scroll. For additional information, refer to <>. +_Below the fold_ refers to panels that are not immediately visible when you open a dashboard, but become visible as you scroll. For additional information, refer to <>. [[labs-dashboard-enable-ui]]`labs:dashboard:enable_ui`:: When enabled, provides access to the experimental *Labs* features for *Dashboard*. diff --git a/docs/setup/upgrade/resolving-migration-failures.asciidoc b/docs/setup/upgrade/resolving-migration-failures.asciidoc index 7ba4bc7205fcf..85847b15cb084 100644 --- a/docs/setup/upgrade/resolving-migration-failures.asciidoc +++ b/docs/setup/upgrade/resolving-migration-failures.asciidoc @@ -8,9 +8,9 @@ with the new version. ==== Saved object migration failures If {kib} unexpectedly terminates while migrating a saved object index, {kib} automatically attempts to -perform the migration again when the process restarts. Do not delete any saved objects indices to -to fix a failed migration. Unlike previous versions, {kib} 7.12.0 and -later does not require deleting indices to release a failed migration lock. +perform the migration again when the process restarts. Do not delete any saved objects indices to +fix a failed migration. Unlike previous versions, {kib} 7.12.0 and later does not require deleting +indices to release a failed migration lock. If upgrade migrations fail repeatedly, refer to <>. diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc index bf13661b9aadd..842f2e93bc58e 100644 --- a/docs/user/dashboard/aggregation-based.asciidoc +++ b/docs/user/dashboard/aggregation-based.asciidoc @@ -172,7 +172,7 @@ To create the bar chart, add a <>, then .. Click *Update*. + [role="screenshot"] -image:images/bar-chart-tutorial-1.png[Bar chart with sample logs data] +image:images/aggBased_barChartTutorial1_8.3.png[Bar chart with sample logs data] . To show the top five log traffic sources, add a sub-bucket aggregation. @@ -187,7 +187,7 @@ TIP: Aggregation-based panels support a maximum of three *Split series*. .. Click *Update*. + [role="screenshot"] -image:images/bar-chart-tutorial-2.png[Bar chart with sample logs data] +image:images/aggBased_barChartTutorial2_8.3.png[Bar chart with sample logs data] [float] [[save-the-aggregation-based-panel]] diff --git a/docs/user/dashboard/dashboard-troubleshooting.asciidoc b/docs/user/dashboard/dashboard-troubleshooting.asciidoc index d9bf80a5b1996..7fe1b7c3067b9 100644 --- a/docs/user/dashboard/dashboard-troubleshooting.asciidoc +++ b/docs/user/dashboard/dashboard-troubleshooting.asciidoc @@ -1,14 +1,5 @@ [[dashboard-troubleshooting]] -== Dashboard and visualizations troubleshooting -++++ -Troubleshooting -++++ - -Find solutions to common dashboard and visualization issues. - -[float] -[[defer-loading-panels-below-the-fold]] -=== Improve dashboard loading time +== Improve dashboard loading time To improve the dashboard loading time, enable *Defer loading panels below the fold* *Lab*, which loads dashboard panels as they become visible on the dashboard. @@ -26,44 +17,3 @@ To enable *Labs*, contact your administrator, or configure the < Aggregation based*, then select *Timelion*. - -.. In your browser, open a new tab, the open the *Timelion* app. - -.. Select the chart you want to copy, then copy the chart expression. -+ -[role="screenshot"] -image::images/timelion-copy-expression.png[Timelion app chart] - -.. Go to the *Timelion* editor, paste the chart expression in the *Timelion expression* field, then click *Update*. -+ -[role="screenshot"] -image::images/timelion-vis-paste-expression.png[Timelion advanced editor UI] - -. Save the visualization. - -.. In the toolbar, click *Save to library*. - -.. Enter the *Title* and add any applicable <>. - -.. Make sure that *Add to Dashboard after saving* is selected. - -.. Click *Save and return*. -+ -The Timelion visualization panel appears on the dashboard. -+ -[role="screenshot"] -image::user/dashboard/images/timelion-dashboard.png[Final dashboard with saved Timelion app worksheet] - diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc index b63bbdc75e9f9..e0e469c0d7d11 100644 --- a/docs/user/dashboard/dashboard.asciidoc +++ b/docs/user/dashboard/dashboard.asciidoc @@ -337,6 +337,8 @@ Apply a set of design options to the entire dashboard. * *Sync color pallettes across panels* — Applies the same color palette to all panels on the dashboard. +* *Sync tooltips across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY chart, the tooltips on all other related dashboard charts automatically appear. + [float] [[save-dashboards]] == Save dashboards diff --git a/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png b/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png new file mode 100644 index 0000000000000..3322459294d3c Binary files /dev/null and b/docs/user/dashboard/images/Screen Shot 2022-06-13 at 3.41.52 PM.png differ diff --git a/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png b/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png new file mode 100644 index 0000000000000..a30fe3fbd1b78 Binary files /dev/null and b/docs/user/dashboard/images/aggBased_barChartTutorial1_8.3.png differ diff --git a/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png b/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png new file mode 100644 index 0000000000000..d1d7f0644db31 Binary files /dev/null and b/docs/user/dashboard/images/aggBased_barChartTutorial2_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif new file mode 100644 index 0000000000000..2015830f68fec Binary files /dev/null and b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png new file mode 100644 index 0000000000000..06ad04c8d1e30 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_discoverDrilldown_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif b/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif new file mode 100644 index 0000000000000..9a50761f7bc24 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_drilldownOnDataTable_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png b/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png new file mode 100644 index 0000000000000..e2df865c610a8 Binary files /dev/null and b/docs/user/dashboard/images/dashboard_drilldownOnPanel_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png b/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png new file mode 100644 index 0000000000000..bd7b9e42c936f Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownGithub_8.3.png differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif b/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif new file mode 100644 index 0000000000000..3edf44454ec5f Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownGoToGitHub_8.3.gif differ diff --git a/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png b/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png new file mode 100644 index 0000000000000..6556485259d6e Binary files /dev/null and b/docs/user/dashboard/images/dashboard_urlDrilldownPopup_8.3.png differ diff --git a/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png b/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png new file mode 100644 index 0000000000000..01b20fe0a1a4c Binary files /dev/null and b/docs/user/dashboard/images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png differ diff --git a/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png b/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png new file mode 100644 index 0000000000000..2a4c2abee24af Binary files /dev/null and b/docs/user/dashboard/images/lens_barChartCustomTimeInterval_8.3.png differ diff --git a/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png b/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png new file mode 100644 index 0000000000000..857f28303b8cb Binary files /dev/null and b/docs/user/dashboard/images/lens_dataViewDropDown_8.3.png differ diff --git a/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png b/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png new file mode 100644 index 0000000000000..5a6cfb2bf740a Binary files /dev/null and b/docs/user/dashboard/images/lens_lineChartMetricOverTimeBottomAxis_8.3.png differ diff --git a/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png b/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png new file mode 100644 index 0000000000000..9c2e3626bc07f Binary files /dev/null and b/docs/user/dashboard/images/lens_lineChartMetricOverTimeLeftAxis_8.3.png differ diff --git a/docs/user/dashboard/images/lens_logsDashboard_8.3.png b/docs/user/dashboard/images/lens_logsDashboard_8.3.png new file mode 100644 index 0000000000000..089fd5dcadb0c Binary files /dev/null and b/docs/user/dashboard/images/lens_logsDashboard_8.3.png differ diff --git a/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png b/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png new file mode 100644 index 0000000000000..93447edf25c91 Binary files /dev/null and b/docs/user/dashboard/images/lens_metricUniqueVisitors_8.3.png differ diff --git a/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png b/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png new file mode 100644 index 0000000000000..80b1763d32633 Binary files /dev/null and b/docs/user/dashboard/images/lens_runtimeFieldMenu_8.3.png differ diff --git a/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png b/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png new file mode 100644 index 0000000000000..9cf54d1cbfdc1 Binary files /dev/null and b/docs/user/dashboard/images/lens_timeSeriesDataTutorialDashboard_8.3.png differ diff --git a/docs/user/dashboard/lens-advanced.asciidoc b/docs/user/dashboard/lens-advanced.asciidoc index d98fd6c45c49f..68516b49d2158 100644 --- a/docs/user/dashboard/lens-advanced.asciidoc +++ b/docs/user/dashboard/lens-advanced.asciidoc @@ -6,7 +6,7 @@ In this tutorial, you'll use the ecommerce sample data to analyze sales trends, When you're done, you'll have a complete overview of the sample web logs data. [role="screenshot"] -image::images/lens_timeSeriesDataTutorialDashboard_7.16.png[Final dashboard with ecommerce sample data] +image::images/lens_timeSeriesDataTutorialDashboard_8.3.png[Final dashboard with ecommerce sample data] Before you begin, you should be familiar with the <>. @@ -34,7 +34,7 @@ Open the visualization editor, then make sure the correct fields appear. . On the dashboard, click *Create visualization*. -. Make sure the *kibana_sample_data_ecommerce* {data-source} appears, then set the <> to *Last 30 days*. +. Make sure the *Kibana Sample Data eCommerce* {data-source} appears, then set the <> to *Last 30 days*. [discrete] [[custom-time-interval]] @@ -55,7 +55,7 @@ image::images/lens_clickAndDragZoom_7.16.gif[Cursor clicking and dragging across . In the layer pane, click *Count of Records*. -.. In the *Display name* field, enter `Number of orders`. +.. In the *Name* field, enter `Number of orders`. .. Click *Add advanced options > Normalize by unit*. @@ -63,7 +63,7 @@ image::images/lens_clickAndDragZoom_7.16.gif[Cursor clicking and dragging across + *Normalize unit* converts *Average sales per 12 hours* into *Average sales per 12 hours (per hour)* by dividing the number of hours. -. To hide the *Horizontal axis* label, open the *Bottom Axis* menu, then deselect *Show*. +. To hide the *Horizontal axis* label, open the *Bottom Axis* menu, then select *None* from the *Axis title* dropdown. To identify the 75th percentile of orders, add a reference line: @@ -71,13 +71,17 @@ To identify the 75th percentile of orders, add a reference line: . Click *Static value*. -. Click the *Percentile* function, then enter `75` in the *Percentile* field. +.. Click *Quick functions*, then click *Percentile*. + +.. From the *Field* dropdown, select *total_quantity*. + +.. In the *Percentile* field, enter `75`. . Configure the display options. -.. In the *Display name* field, enter `75th`. +.. In the *Name* field, enter `75th`. -.. Select *Show display name*. +.. To display the name, select *Name* from *Text decoration*. .. From the *Icon* dropdown, select *Tag*. @@ -86,7 +90,7 @@ To identify the 75th percentile of orders, add a reference line: . Click *Close*. + [role="screenshot"] -image::images/lens_barChartCustomTimeInterval_7.16.png[Orders per day] +image::images/lens_barChartCustomTimeInterval_8.3.png[Orders per day] . Click *Save and return*. @@ -110,7 +114,7 @@ Create the 95th price distribution percentile: . Click the *Percentile* function. -. In the *Display name* field, enter `95th`, then click *Close*. +. In the *Name* field, enter `95th`, then click *Close*. To copy a function, you drag it to the *Drop a field or click to add* field within the same group. To create the 90th percentile, duplicate the `95th` percentile: @@ -121,11 +125,11 @@ image::images/lens_advanced_2_2.gif[Easily duplicate the items with drag and dro . Click *95th [1]*, then enter `90` in the *Percentile* field. -. In the *Display name* field enter `90th`, then click *Close*. +. In the *Name* field enter `90th`, then click *Close*. . To create the `50th` and `10th` percentiles, repeat the duplication steps. -. Open the *Left Axis* menu, then enter `Percentiles for product prices` in the *Axis name* field. +. Open the *Left Axis* menu, select *Custom* from the *Axis title* dropdown, then enter `Percentiles for product prices` in the *Axis title* field. + [role="screenshot"] image::images/lens_lineChartMultipleDataSeries_7.16.png[Percentiles for product prices chart] @@ -148,7 +152,7 @@ To analyze multiple visualization types, create an area chart that displays the .. Click the *Average* function. -.. In the *Display name* field, enter `Average price`, then click *Close*. +.. In the *Name* field, enter `Average price`, then click *Close*. . Open the *Visualization type* dropdown, then select *Area*. @@ -160,7 +164,7 @@ Add a layer to display the customer traffic: . In the layer pane, click *Unique count of customer_id*. -.. In the *Display name* field, enter `Number of customers`. +.. In the *Name* field, enter `Number of customers`. .. In the *Series color* field, enter *#D36086*. @@ -223,7 +227,7 @@ For each order category, create a filter: . Open the *Legend* menu, then select the *Alignment* arrow that points up. + [role="screenshot"] -image::images/lens_areaPercentageNumberOfOrdersByCategory_7.16.png[Prices share by category] +image::images/lens_areaPercentageNumberOfOrdersByCategory_8.3.png[Prices share by category] . Click *Save and return*. @@ -245,7 +249,7 @@ Configure the cumulative sum of store orders: . Click the *Cumulative sum* function. -. In the *Display name* field, enter `Cumulative weekend orders`, then click *Close*. +. In the *Name* field, enter `Cumulative weekend orders`, then click *Close*. Filter the results to display the data for only Saturday and Sunday: @@ -261,7 +265,7 @@ Filter the results to display the data for only Saturday and Sunday: + The <> displays all documents where `day_of_week` matches `Saturday` or `Sunday`. -. Open the *Legend* menu, then click *Hide*. +. Open the *Legend* menu, then click *Hide* next to *Display*. + [role="screenshot"] image::images/lens_areaChartCumulativeNumberOfSalesOnWeekend_7.16.png[Area chart with cumulative sum of orders made on the weekend] @@ -318,7 +322,7 @@ To compare time range changes as a percent, create a bar chart that compares the . Open the *Value format* dropdown, select *Percent*, then enter `0` in the *Decimals* field. -. In the *Display name* field, enter `Percent of change`, then click *Close*. +. In the *Name* field, enter `Percent of change`, then click *Close*. + [role="screenshot"] image::images/lens_percent_chage.png[Bar chart with percent change in sales between the current time and the previous week] @@ -341,17 +345,15 @@ Create a date histogram table and group the customer count metric by category, s .. In the layer pane, click *Unique count of customer_id*. -.. In the *Display name* field, enter `Customers`, then click *Close*. +.. In the *Name* field, enter `Customers`, then click *Close*. . From the *Available fields* list, drag *order_date* to the *Rows* field in the layer pane. .. In the layer pane, click the *order_date*. -.. Select *Customize time interval*. - -.. Change the *Minimum interval* to *1 days*. +.. In the *Minimum interval* field, enter *1d*. -.. In the *Display name* field, enter `Sales`, then click *Close*. +.. In the *Name* field, enter `Sales`, then click *Close*. To split the metric, add columns for each continent using the *Columns* field: @@ -376,4 +378,4 @@ Now that you have a complete overview of your ecommerce sales data, save the das . Click *Save*. [role="screenshot"] -image::images/lens_timeSeriesDataTutorialDashboard_7.16.png[Final dashboard with ecommerce sample data] +image::images/lens_timeSeriesDataTutorialDashboard_8.3.png[Final dashboard with ecommerce sample data] diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index b062dcc3349ad..8e8ffe902a565 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -40,7 +40,7 @@ If you already know the visualization type you want to use, and how you want to Choose the visualization type. -. Before you drag fields to the workspace, open the *Chart type* dropdown, then select the visualization type. +. Before you drag fields to the workspace, open the *Visualization type* dropdown, then select the visualization you want to use. . To view more visualizations that *Lens* automatically created for the fields, click *Suggestions*. If one of the *Suggestions* meets your visualization needs, click *Save and return* to add it to the dashboard. @@ -66,14 +66,14 @@ TIP: You can manually apply the changes you make, which is helpful when creating Change the fields list to display a different {data-source}, different time range, or add your own fields. -* To create a visualization with fields in a different {data-source}, open the *Data view* dropdown, then select the {data-source}. +* To create a visualization with fields in a different {data-source}, open the {data-source} dropdown, then select the {data-source}. * If the fields list is empty, change the <>. -* To add fields, open the action menu (*...*) next to the *Data view* dropdown, then select *Add field to {data-source}*. +* To add fields, open the {data-source} dropdown, then select *Add a field to this {data-source}*. + [role="screenshot"] -image:images/runtime-field-menu.png[Dropdown menu located next to {data-source} field with items for adding and managing fields, width=50%] +image:images/lens_dataViewDropDown_8.3.png[Dropdown menu located next to {data-source} field with items for adding and managing fields] + For more information about adding fields to {data-sources} and examples, refer to <>. @@ -83,7 +83,7 @@ For more information about adding fields to {data-sources} and examples, refer t Tables are highly customizable, and provide you with text alignment, value formatting, coloring options, and more. -. From the *Chart type* dropdown, select *Table*. +. From the *Visualization type* dropdown, select *Table*. . Drag the fields you want to visualize to the workspace. @@ -91,9 +91,9 @@ Tables are highly customizable, and provide you with text alignment, value forma + All columns that belong to the same layer pane group are sorted in the table. -. To change the display options, click a *Metrics* field, then configure the following options: +. To change the display options, click a *Metrics* field in the layer pane, then configure the following options: -* *Display name* — Specifies the field display name. +* *Name* — Specifies the field display name. * *Value format* — Specifies how the field value displays in the table. @@ -111,9 +111,6 @@ All columns that belong to the same layer pane group are sorted in the table. To use a keyboard instead of a mouse, use the *Lens* fully accessible and continuously improved drag system. -[role="screenshot"] -image::images/lens_drag_drop_1.gif[Presented Lens drag and drop] - . Select the field in the fields list or layer pane. Most fields have an inner and outer select state. The inner state opens a panel with detailed information or options. The outer state allows you to drag the field. Tab through the fields until you get the outer state on the field. + @@ -197,7 +194,13 @@ image::images/lens_annotations_8.2.0.png[Lens annotations] . To open the annotation options, click *Event*. -. Specify the *Annotation date*, then change the *Appearance* options you want to display. +. Specify the *Annotation date*. + +. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* time range. + +. Enter the annotation *Name*. + +. Change the *Appearance* options for how you want the annotation to display. . Click *Close*. diff --git a/docs/user/dashboard/make-dashboards-interactive.asciidoc b/docs/user/dashboard/make-dashboards-interactive.asciidoc index 0e20237c2ebc0..7c80fa8588538 100644 --- a/docs/user/dashboard/make-dashboards-interactive.asciidoc +++ b/docs/user/dashboard/make-dashboards-interactive.asciidoc @@ -172,12 +172,14 @@ To use saved search interactions, open the panel menu, then click *More > View s Panels have built-in interactive capabilities that apply filters to the dashboard data. For example, when you drag a time range or click a pie slice, a filter for the time range or pie slice is applied. Drilldowns let you customize the interactive behavior while keeping the context of the interaction. -There are two types of drilldowns you can add to dashboards: +There are three types of drilldowns you can add to dashboards: -* *Dashboard* — Navigates you from one dashboard to another dashboard. For example, when can create a drilldown for a *Lens* panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name. +* *Dashboard* — Navigates you from one dashboard to another dashboard. For example, create a drilldown for a *Lens* panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name. * *URL* — Navigates you from a dashboard to an external website. For example, a website with the specific host name as a parameter. +* *Discover* — Navigates you from a *Lens* dashboard panel to *Discover*. For example, create a drilldown for a *Lens* visualization that opens the visualization data in *Discover* for further exploration. + Third-party developers can create drilldowns. To learn how to code drilldowns, refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin]. [float] @@ -189,7 +191,7 @@ Dashboard drilldowns enable you to open a dashboard from another dashboard, taki For example, if you have a dashboard that shows the logs and metrics for multiple data centers, you can create a drilldown that navigates from the dashboard that shows multiple data centers, to a dashboard that shows a single data center or server. [role="screenshot"] -image:images/drilldown_on_data_table.gif[Drilldown on data table that navigates to another dashboard] +image:images/dashboard_drilldownOnDataTable_8.3.gif[Drilldown on data table that navigates to another dashboard] The panels you create using the following editors support dashboard drilldowns: @@ -220,7 +222,7 @@ Use the <> data to create a dashboard + [%hardbreaks] Search: `extension.keyword: ("gz" or "css" or "deb")` -Filter: `geo.src: CN` +Filter: `geo.src: US` [float] ===== Create the dashboard drilldown @@ -244,7 +246,7 @@ Create a drilldown that opens the *Detailed logs* dashboard from the *[Logs] Web . In the data table panel, hover over a value, click *+*, then select `View details`. + [role="screenshot"] -image::images/drilldown_on_panel.png[Drilldown on data table that navigates to another dashboard] +image::images/dashboard_drilldownOnPanel_8.3.png[Drilldown on data table that navigates to another dashboard] [float] [[url-drilldowns]] @@ -253,7 +255,7 @@ image::images/drilldown_on_panel.png[Drilldown on data table that navigates to a URL drilldowns enable you to navigate from a dashboard to external websites. Destination URLs can be dynamic, depending on the dashboard context or user interaction with a panel. To create URL drilldowns, you add <> to a URL template, which configures the behavior of the drilldown. All panels that you create with the visualization editors support dashboard drilldowns. [role="screenshot"] -image:images/url_drilldown_go_to_github.gif[Drilldown on pie chart that navigates to Github] +image:images/dashboard_urlDrilldownGoToGitHub_8.3.gif[Drilldown on pie chart that navigates to Github] Some panels support multiple interactions, also known as triggers. The <> you use to create a <> depends on the trigger you choose. URL drilldowns support these types of triggers: @@ -269,7 +271,7 @@ For example, *Single click* has `{{event.value}}` and *Range selection* has `{{e For example, if you have a dashboard that shows data from a Github repository, you can create a URL drilldown that opens Github from the dashboard panel. -. Add the *Sample web logs* data. +. Add the <> data. . Open the *[Logs] Web Traffic* dashboard. @@ -277,13 +279,11 @@ For example, if you have a dashboard that shows data from a Github repository, y . Create a donut chart -.. In the toolbar, click *Edit*. - .. Click *Create visualization*. .. From the *Chart type* dropdown, select *Donut*. -.. From the *Available fields* list, drag and drop the *machine.os.keyword* field onto the visualization builder. +.. From the *Available fields* list, drag *machine.os.keyword* to the workspace. .. Click *Save and return*. @@ -311,12 +311,47 @@ https://github.com/elastic/kibana/issues?q=is:issue+is:open+{{event.value}} . On the donut chart panel, click any chart slice, then select *Show on Github*. + [role="screenshot"] -image:images/url_drilldown_popup.png[URL drilldown popup] +image:images/dashboard_urlDrilldownPopup_8.3.png[URL drilldown popup] . In the list of {kib} repository issues, verify that the slice value appears. + [role="screenshot"] -image:images/url_drilldown_github.png[Github] +image:images/dashboard_urlDrilldownGithub_8.3.png[Open ios issues in the elastic/kibana repository on Github] + +[float] +[[discover-drilldowns]] +==== Create Discover drilldowns + +Discover drilldowns enable you to open *Discover* from a *Lens* dashboard panel, taking the time range, filters, and other parameters with you so the context remains the same. + +For example, when you create a Discover drilldown for a pie chart, you can click a slice in the pie chart, and only the documents for the slice appear in *Discover*. + +[role="screenshot"] +image:images/dashboard_discoverDrilldown_8.3.gif[Drilldown on bar vertical stacked chart that navigates to Discover] + +NOTE: Discover drilldowns are supported only by *Lens* panels. To open all of the *Lens* dashboard panel data in *Discover*, check <>. + +[float] +===== Create the Discover drilldown + +Create a drilldown that opens *Discover* from the <> data *[Logs] Web Traffic* dashboard. + +. Click *Edit*, open the panel menu for the *[Logs] Bytes distribution* bar vertical stacked chart, then select *Create drilldown*. + +. Click *Open in Discover*. + +. Give the drilldown a name. For example, `View bytes distribution in Discover`. + +. To open the Discover drilldown in a new tab, select *Open in new tab*. + +. Click *Create drilldown*. + +. Save the dashboard. + +. On the *[Logs] Bytes distribution* bar vertical stacked chart, click a bar, then select *View bytes distribution in Discover*. ++ +[role="screenshot"] +image::images/dashboard_discoverDrilldown_8.3.png[Drilldown on bar vertical stacked chart that navigates to Discover] [float] [[manage-drilldowns]] diff --git a/docs/user/dashboard/timelion.asciidoc b/docs/user/dashboard/timelion.asciidoc index 19962d11f7335..7e5b753973ea2 100644 --- a/docs/user/dashboard/timelion.asciidoc +++ b/docs/user/dashboard/timelion.asciidoc @@ -13,8 +13,6 @@ The syntax enables some features that classical point series charts don't offer, [role="screenshot"] image:dashboard/images/timelion.png[Timelion] -deprecated::[7.0.0,"*Timelion* is still supported. The *Timelion app* is deprecated in 7.0, replaced by dashboard features. In 7.16 and later, the *Timelion app* is removed from {kib}. To prepare for the removal of *Timelion app*, you must migrate *Timelion app* worksheets to a dashboard. For information on how to migrate *Timelion app* worksheets, refer to <>."] - [float] ==== Timelion expressions diff --git a/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc b/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc index 7437eb480e73f..1d4d5d70e879e 100644 --- a/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc +++ b/docs/user/dashboard/tutorial-create-a-dashboard-of-lens-panels.asciidoc @@ -8,7 +8,7 @@ at website logs, but this type of dashboard works on any type of data. When you're done, you'll have a complete overview of the sample web logs data. [role="screenshot"] -image::images/lens_logsDashboard_7.16.png[Logs dashboard] +image::images/lens_logsDashboard_8.3.png[Logs dashboard] Before you begin, you should be familiar with the <>. @@ -38,10 +38,10 @@ Open the visualization editor, then make sure the correct fields appear. . On the dashboard, click *Create visualization*. -. Make sure the *kibana_sample_data_logs* index appears. +. Make sure the *kibana_sample_data_logs* data view appears. + [role="screenshot"] -image::images/lens_dataViewDropDown_8.0.png[Data view dropdown] +image::images/lens_dataViewDropDown_8.3.png[Data view dropdown] To create the visualizations in this tutorial, you'll use the following fields: @@ -79,12 +79,9 @@ In the layer pane, *Unique count of clientip* appears because the editor automat . In the layer pane, click *Unique count of clientip*. -.. In the *Display name* field, enter `Unique visitors`. +.. In the *Name* field, enter `Unique visitors`. .. Click *Close*. -+ -[role="screenshot"] -image::images/lens_metricUniqueVisitors_7.16.png[Metric visualization that displays number of unique visitors] . Click *Save and return*. + @@ -122,23 +119,21 @@ To increase the minimum time interval: . In the layer pane, click *timestamp*. -. Select *Customize time interval*. - -. Change the *Minimum interval* to *1 days*, then click *Close*. +. Change the *Minimum interval* to *1d*, then click *Close*. + -You can increase and decrease the minimum interval, but you are unable to decrease the interval below the <>. +You can increase and decrease the minimum interval, but you are unable to decrease the interval below the configured <>. To save space on the dashboard, hide the axis labels. -. Open the *Left axis* menu, then deselect *Show*. +. Open the *Left axis* menu, then select *None* from the *Axis title* dropdown. + [role="screenshot"] -image::images/lens_leftAxisMenu_7.16.png[Left axis menu] +image::images/lens_lineChartMetricOverTimeLeftAxis_8.3.png[Left axis menu] -. Open the *Bottom axis* menu, then deselect *Show*. +. Open the *Bottom axis* menu, then select *None* from the *Axis title* dropdown. + [role="screenshot"] -image::images/lens_lineChartMetricOverTime_7.16.png[Line chart that displays metric data over time] +image::images/lens_lineChartMetricOverTimeBottomAxis_8.3.png[Line chart that displays metric data over time] . Click *Save and return* @@ -183,7 +178,7 @@ image::images/lens_end_to_end_2_1_2.png[Table with top values of request.keyword .. In the *Number of values* field, enter `10`. -.. In the *Display name* field, enter `Page URL`. +.. In the *Name* field, enter `Page URL`. .. Click *Close*. + @@ -204,7 +199,9 @@ Create a proportional visualization that helps you determine if your users trans . From the *Available fields* list, drag *bytes* to the *Vertical axis* field in the layer pane. -. Click *Median of bytes*, click the *Sum* function, then click *Close*. +. In the layer pane, click *Median of bytes*. + +. Click the *Sum* function, then click *Close*. . From the *Available fields* list, drag *bytes* to the *Break down by* field in the layer pane. @@ -261,7 +258,7 @@ The distribution of a number can help you find patterns. For example, you can an .. Click the *Sum* function. -.. In the *Display name* field, enter `Transferred bytes`. +.. In the *Name* field, enter `Transferred bytes`. .. From the *Value format* dropdown, select *Bytes (1024)*, then click *Close*. @@ -292,11 +289,11 @@ Add a panel title: . From the *Available fields* list, drag *Records* to the *Size by* field in the layer pane. -. In the editor, click *Add or drag-and-drop a field* for *Group by*. +. In the layer pane, click *Add or drag-and-drop a field* for *Group by*. Create a filter for each website traffic source: -. From *Select a function*, click *Filters*. +. Click the *Filters* function. . Click *All records*, enter the following in the query bar, then press Return: @@ -331,7 +328,7 @@ Remove the documents that do not match the filter criteria: . In the layer pane, click *Top values of geo.srcdest*. -. Click *Advanced*, then deselect *Group other values as "Other"*, the click *Close*. +. Click *Advanced*, deselect *Group other values as "Other"*, then click *Close*. + [role="screenshot"] image::images/lens_treemapMultiLevelChart_7.16.png[Treemap visualization] @@ -361,7 +358,7 @@ Decrease the size of the following panels, then move the panels to the first row * *Website traffic* + [role="screenshot"] -image::images/lens_logsDashboard_7.16.png[Logs dashboard] +image::images/lens_logsDashboard_8.3.png[Logs dashboard] [discrete] === Save the dashboard diff --git a/package.json b/package.json index 0cf2676cdc172..717392523c956 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,6 @@ "debug": "node --nolazy --inspect scripts/kibana --dev", "debug-break": "node --nolazy --inspect-brk scripts/kibana --dev", "dev-docs": "scripts/dev_docs.sh", - "docs:acceptApiChanges": "node --max-old-space-size=6144 scripts/check_published_api_changes.js --accept", "es": "node scripts/es", "preinstall": "node ./preinstall_check", "kbn": "node scripts/kbn", @@ -75,7 +74,7 @@ }, "resolutions": { "**/@babel/runtime": "^7.17.9", - "**/@types/node": "16.11.7", + "**/@types/node": "16.11.41", "**/chokidar": "^3.4.3", "**/deepmerge": "^4.2.2", "**/fast-deep-equal": "^3.1.1", @@ -108,9 +107,9 @@ "@elastic/apm-synthtrace": "link:bazel-bin/packages/elastic-apm-synthtrace", "@elastic/charts": "46.10.2", "@elastic/datemath": "5.0.3", - "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.2.0-canary.2", + "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.3.0-canary.1", "@elastic/ems-client": "8.3.3", - "@elastic/eui": "58.0.0", + "@elastic/eui": "59.0.1", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -143,6 +142,7 @@ "@kbn/analytics-shippers-fullstory": "link:bazel-bin/packages/analytics/shippers/fullstory", "@kbn/apm-config-loader": "link:bazel-bin/packages/kbn-apm-config-loader", "@kbn/apm-utils": "link:bazel-bin/packages/kbn-apm-utils", + "@kbn/ci-stats-performance-metrics": "link:bazel-bin/packages/kbn-ci-stats-performance-metrics", "@kbn/coloring": "link:bazel-bin/packages/kbn-coloring", "@kbn/config": "link:bazel-bin/packages/kbn-config", "@kbn/config-mocks": "link:bazel-bin/packages/kbn-config-mocks", @@ -150,18 +150,26 @@ "@kbn/core-analytics-browser": "link:bazel-bin/packages/core/analytics/core-analytics-browser", "@kbn/core-analytics-browser-internal": "link:bazel-bin/packages/core/analytics/core-analytics-browser-internal", "@kbn/core-analytics-browser-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-browser-mocks", + "@kbn/core-analytics-server": "link:bazel-bin/packages/core/analytics/core-analytics-server", + "@kbn/core-analytics-server-internal": "link:bazel-bin/packages/core/analytics/core-analytics-server-internal", + "@kbn/core-analytics-server-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-server-mocks", "@kbn/core-base-browser-internal": "link:bazel-bin/packages/core/base/core-base-browser-internal", "@kbn/core-base-browser-mocks": "link:bazel-bin/packages/core/base/core-base-browser-mocks", "@kbn/core-base-common": "link:bazel-bin/packages/core/base/core-base-common", "@kbn/core-base-common-internal": "link:bazel-bin/packages/core/base/core-base-common-internal", "@kbn/core-base-server-internal": "link:bazel-bin/packages/core/base/core-base-server-internal", "@kbn/core-base-server-mocks": "link:bazel-bin/packages/core/base/core-base-server-mocks", + "@kbn/core-config-server-internal": "link:bazel-bin/packages/core/config/core-config-server-internal", + "@kbn/core-config-server-mocks": "link:bazel-bin/packages/core/config/core-config-server-mocks", "@kbn/core-doc-links-browser": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser", "@kbn/core-doc-links-browser-internal": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser-internal", "@kbn/core-doc-links-browser-mocks": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser-mocks", "@kbn/core-doc-links-server": "link:bazel-bin/packages/core/doc-links/core-doc-links-server", "@kbn/core-doc-links-server-internal": "link:bazel-bin/packages/core/doc-links/core-doc-links-server-internal", "@kbn/core-doc-links-server-mocks": "link:bazel-bin/packages/core/doc-links/core-doc-links-server-mocks", + "@kbn/core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser", + "@kbn/core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal", + "@kbn/core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks", "@kbn/core-injected-metadata-browser": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser", "@kbn/core-injected-metadata-browser-internal": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-internal", "@kbn/core-injected-metadata-browser-mocks": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-mocks", @@ -184,10 +192,14 @@ "@kbn/i18n-react": "link:bazel-bin/packages/kbn-i18n-react", "@kbn/interpreter": "link:bazel-bin/packages/kbn-interpreter", "@kbn/io-ts-utils": "link:bazel-bin/packages/kbn-io-ts-utils", + "@kbn/kbn-ci-stats-performance-metrics": "link:bazel-bin/packages/kbn-kbn-ci-stats-performance-metrics", "@kbn/kibana-json-schema": "link:bazel-bin/packages/kbn-kibana-json-schema", "@kbn/logging": "link:bazel-bin/packages/kbn-logging", "@kbn/logging-mocks": "link:bazel-bin/packages/kbn-logging-mocks", "@kbn/mapbox-gl": "link:bazel-bin/packages/kbn-mapbox-gl", + "@kbn/ml-agg-utils": "link:bazel-bin/x-pack/packages/ml/agg_utils", + "@kbn/ml-is-populated-object": "link:bazel-bin/x-pack/packages/ml/is_populated_object", + "@kbn/ml-string-hash": "link:bazel-bin/x-pack/packages/ml/string_hash", "@kbn/monaco": "link:bazel-bin/packages/kbn-monaco", "@kbn/plugin-discovery": "link:bazel-bin/packages/kbn-plugin-discovery", "@kbn/react-field": "link:bazel-bin/packages/kbn-react-field", @@ -211,6 +223,7 @@ "@kbn/shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution", "@kbn/shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen", "@kbn/shared-ux-button-toolbar": "link:bazel-bin/packages/shared-ux/button_toolbar", + "@kbn/shared-ux-card-no-data": "link:bazel-bin/packages/shared-ux/card/no_data", "@kbn/shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components", "@kbn/shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app", "@kbn/shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data", @@ -385,6 +398,7 @@ "proxy-from-env": "1.0.0", "puid": "1.0.7", "puppeteer": "^10.2.0", + "qs": "^6.10.5", "query-string": "^6.13.2", "random-word-slugs": "^0.0.5", "raw-loader": "^3.1.0", @@ -661,6 +675,7 @@ "@types/kbn__bazel-packages": "link:bazel-bin/packages/kbn-bazel-packages/npm_module_types", "@types/kbn__bazel-runner": "link:bazel-bin/packages/kbn-bazel-runner/npm_module_types", "@types/kbn__ci-stats-core": "link:bazel-bin/packages/kbn-ci-stats-core/npm_module_types", + "@types/kbn__ci-stats-performance-metrics": "link:bazel-bin/packages/kbn-ci-stats-performance-metrics/npm_module_types", "@types/kbn__ci-stats-reporter": "link:bazel-bin/packages/kbn-ci-stats-reporter/npm_module_types", "@types/kbn__cli-dev-mode": "link:bazel-bin/packages/kbn-cli-dev-mode/npm_module_types", "@types/kbn__coloring": "link:bazel-bin/packages/kbn-coloring/npm_module_types", @@ -670,6 +685,9 @@ "@types/kbn__core-analytics-browser": "link:bazel-bin/packages/core/analytics/core-analytics-browser/npm_module_types", "@types/kbn__core-analytics-browser-internal": "link:bazel-bin/packages/core/analytics/core-analytics-browser-internal/npm_module_types", "@types/kbn__core-analytics-browser-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-browser-mocks/npm_module_types", + "@types/kbn__core-analytics-server": "link:bazel-bin/packages/core/analytics/core-analytics-server/npm_module_types", + "@types/kbn__core-analytics-server-internal": "link:bazel-bin/packages/core/analytics/core-analytics-server-internal/npm_module_types", + "@types/kbn__core-analytics-server-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-server-mocks/npm_module_types", "@types/kbn__core-base-browser": "link:bazel-bin/packages/core/base/core-base-browser/npm_module_types", "@types/kbn__core-base-browser-internal": "link:bazel-bin/packages/core/base/core-base-browser-internal/npm_module_types", "@types/kbn__core-base-browser-mocks": "link:bazel-bin/packages/core/base/core-base-browser-mocks/npm_module_types", @@ -679,12 +697,17 @@ "@types/kbn__core-base-server-internal": "link:bazel-bin/packages/core/base/core-base-server-internal/npm_module_types", "@types/kbn__core-base-server-mocks": "link:bazel-bin/packages/core/base/core-base-server-mocks/npm_module_types", "@types/kbn__core-common-internal-base": "link:bazel-bin/packages/core/common/internal-base/npm_module_types", + "@types/kbn__core-config-server-internal": "link:bazel-bin/packages/core/config/core-config-server-internal/npm_module_types", + "@types/kbn__core-config-server-mocks": "link:bazel-bin/packages/core/config/core-config-server-mocks/npm_module_types", "@types/kbn__core-doc-links-browser": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser/npm_module_types", "@types/kbn__core-doc-links-browser-internal": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser-internal/npm_module_types", "@types/kbn__core-doc-links-browser-mocks": "link:bazel-bin/packages/core/doc-links/core-doc-links-browser-mocks/npm_module_types", "@types/kbn__core-doc-links-server": "link:bazel-bin/packages/core/doc-links/core-doc-links-server/npm_module_types", "@types/kbn__core-doc-links-server-internal": "link:bazel-bin/packages/core/doc-links/core-doc-links-server-internal/npm_module_types", "@types/kbn__core-doc-links-server-mocks": "link:bazel-bin/packages/core/doc-links/core-doc-links-server-mocks/npm_module_types", + "@types/kbn__core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser/npm_module_types", + "@types/kbn__core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal/npm_module_types", + "@types/kbn__core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks/npm_module_types", "@types/kbn__core-injected-metadata-browser": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser/npm_module_types", "@types/kbn__core-injected-metadata-browser-internal": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-internal/npm_module_types", "@types/kbn__core-injected-metadata-browser-mocks": "link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-mocks/npm_module_types", @@ -718,10 +741,14 @@ "@types/kbn__interpreter": "link:bazel-bin/packages/kbn-interpreter/npm_module_types", "@types/kbn__io-ts-utils": "link:bazel-bin/packages/kbn-io-ts-utils/npm_module_types", "@types/kbn__jest-serializers": "link:bazel-bin/packages/kbn-jest-serializers/npm_module_types", + "@types/kbn__kbn-ci-stats-performance-metrics": "link:bazel-bin/packages/kbn-kbn-ci-stats-performance-metrics/npm_module_types", "@types/kbn__kibana-json-schema": "link:bazel-bin/packages/kbn-kibana-json-schema/npm_module_types", "@types/kbn__logging": "link:bazel-bin/packages/kbn-logging/npm_module_types", "@types/kbn__logging-mocks": "link:bazel-bin/packages/kbn-logging-mocks/npm_module_types", "@types/kbn__mapbox-gl": "link:bazel-bin/packages/kbn-mapbox-gl/npm_module_types", + "@types/kbn__ml-agg-utils": "link:bazel-bin/x-pack/packages/ml/agg_utils/npm_module_types", + "@types/kbn__ml-is-populated-object": "link:bazel-bin/x-pack/packages/ml/is_populated_object/npm_module_types", + "@types/kbn__ml-string-hash": "link:bazel-bin/x-pack/packages/ml/string_hash/npm_module_types", "@types/kbn__monaco": "link:bazel-bin/packages/kbn-monaco/npm_module_types", "@types/kbn__optimizer": "link:bazel-bin/packages/kbn-optimizer/npm_module_types", "@types/kbn__optimizer-webpack-helpers": "link:bazel-bin/packages/kbn-optimizer-webpack-helpers/npm_module_types", @@ -751,6 +778,7 @@ "@types/kbn__shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution/npm_module_types", "@types/kbn__shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/npm_module_types", "@types/kbn__shared-ux-button-toolbar": "link:bazel-bin/packages/shared-ux/button_toolbar/npm_module_types", + "@types/kbn__shared-ux-card-no-data": "link:bazel-bin/packages/shared-ux/card/no_data/npm_module_types", "@types/kbn__shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components/npm_module_types", "@types/kbn__shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app/npm_module_types", "@types/kbn__shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data/npm_module_types", @@ -793,7 +821,7 @@ "@types/mustache": "^0.8.31", "@types/ncp": "^2.0.1", "@types/nock": "^10.0.3", - "@types/node": "16.11.7", + "@types/node": "16.11.41", "@types/node-fetch": "^2.6.0", "@types/node-forge": "^1.0.2", "@types/nodemailer": "^6.4.0", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index cc5c0e13dcccf..253c5cc2b4fb3 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -17,18 +17,25 @@ filegroup( "//packages/core/analytics/core-analytics-browser-internal:build", "//packages/core/analytics/core-analytics-browser-mocks:build", "//packages/core/analytics/core-analytics-browser:build", + "//packages/core/analytics/core-analytics-server-internal:build", + "//packages/core/analytics/core-analytics-server-mocks:build", + "//packages/core/analytics/core-analytics-server:build", "//packages/core/base/core-base-browser-internal:build", "//packages/core/base/core-base-browser-mocks:build", "//packages/core/base/core-base-common-internal:build", "//packages/core/base/core-base-common:build", "//packages/core/base/core-base-server-internal:build", "//packages/core/base/core-base-server-mocks:build", + "//packages/core/config/core-config-server-internal:build", "//packages/core/doc-links/core-doc-links-browser-internal:build", "//packages/core/doc-links/core-doc-links-browser-mocks:build", "//packages/core/doc-links/core-doc-links-browser:build", "//packages/core/doc-links/core-doc-links-server-internal:build", "//packages/core/doc-links/core-doc-links-server-mocks:build", "//packages/core/doc-links/core-doc-links-server:build", + "//packages/core/i18n/core-i18n-browser-internal:build", + "//packages/core/i18n/core-i18n-browser-mocks:build", + "//packages/core/i18n/core-i18n-browser:build", "//packages/core/injected-metadata/core-injected-metadata-browser-internal:build", "//packages/core/injected-metadata/core-injected-metadata-browser-mocks:build", "//packages/core/injected-metadata/core-injected-metadata-browser:build", @@ -55,6 +62,7 @@ filegroup( "//packages/kbn-bazel-packages:build", "//packages/kbn-bazel-runner:build", "//packages/kbn-ci-stats-core:build", + "//packages/kbn-ci-stats-performance-metrics:build", "//packages/kbn-ci-stats-reporter:build", "//packages/kbn-cli-dev-mode:build", "//packages/kbn-coloring:build", @@ -146,10 +154,14 @@ filegroup( "//packages/shared-ux/avatar/solution:build", "//packages/shared-ux/button_toolbar:build", "//packages/shared-ux/button/exit_full_screen:build", + "//packages/shared-ux/card/no_data:build", "//packages/shared-ux/link/redirect_app:build", "//packages/shared-ux/page/analytics_no_data:build", "//packages/shared-ux/page/kibana_no_data:build", "//packages/shared-ux/prompt/no_data_views:build", + "//x-pack/packages/ml/agg_utils:build", + "//x-pack/packages/ml/is_populated_object:build", + "//x-pack/packages/ml/string_hash:build", ], ) @@ -165,18 +177,25 @@ filegroup( "//packages/core/analytics/core-analytics-browser-internal:build_types", "//packages/core/analytics/core-analytics-browser-mocks:build_types", "//packages/core/analytics/core-analytics-browser:build_types", + "//packages/core/analytics/core-analytics-server-internal:build_types", + "//packages/core/analytics/core-analytics-server-mocks:build_types", + "//packages/core/analytics/core-analytics-server:build_types", "//packages/core/base/core-base-browser-internal:build_types", "//packages/core/base/core-base-browser-mocks:build_types", "//packages/core/base/core-base-common-internal:build_types", "//packages/core/base/core-base-common:build_types", "//packages/core/base/core-base-server-internal:build_types", "//packages/core/base/core-base-server-mocks:build_types", + "//packages/core/config/core-config-server-internal:build_types", "//packages/core/doc-links/core-doc-links-browser-internal:build_types", "//packages/core/doc-links/core-doc-links-browser-mocks:build_types", "//packages/core/doc-links/core-doc-links-browser:build_types", "//packages/core/doc-links/core-doc-links-server-internal:build_types", "//packages/core/doc-links/core-doc-links-server-mocks:build_types", "//packages/core/doc-links/core-doc-links-server:build_types", + "//packages/core/i18n/core-i18n-browser-internal:build_types", + "//packages/core/i18n/core-i18n-browser-mocks:build_types", + "//packages/core/i18n/core-i18n-browser:build_types", "//packages/core/injected-metadata/core-injected-metadata-browser-internal:build_types", "//packages/core/injected-metadata/core-injected-metadata-browser-mocks:build_types", "//packages/core/injected-metadata/core-injected-metadata-browser:build_types", @@ -199,6 +218,7 @@ filegroup( "//packages/kbn-bazel-packages:build_types", "//packages/kbn-bazel-runner:build_types", "//packages/kbn-ci-stats-core:build_types", + "//packages/kbn-ci-stats-performance-metrics:build_types", "//packages/kbn-ci-stats-reporter:build_types", "//packages/kbn-cli-dev-mode:build_types", "//packages/kbn-coloring:build_types", @@ -279,10 +299,14 @@ filegroup( "//packages/shared-ux/avatar/solution:build_types", "//packages/shared-ux/button_toolbar:build_types", "//packages/shared-ux/button/exit_full_screen:build_types", + "//packages/shared-ux/card/no_data:build_types", "//packages/shared-ux/link/redirect_app:build_types", "//packages/shared-ux/page/analytics_no_data:build_types", "//packages/shared-ux/page/kibana_no_data:build_types", "//packages/shared-ux/prompt/no_data_views:build_types", + "//x-pack/packages/ml/agg_utils:build_types", + "//x-pack/packages/ml/is_populated_object:build_types", + "//x-pack/packages/ml/string_hash:build_types", ], ) diff --git a/packages/core/analytics/core-analytics-server-internal/BUILD.bazel b/packages/core/analytics/core-analytics-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..f4fc5e7ae3818 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/BUILD.bazel @@ -0,0 +1,101 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-analytics-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-analytics-server-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//rxjs", + "//packages/analytics/client", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//rxjs", + "//packages/analytics/client:npm_module_types", + "//packages/core/base/core-base-server-internal:npm_module_types", + "//packages/core/analytics/core-analytics-server:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/analytics/core-analytics-server-internal/README.md b/packages/core/analytics/core-analytics-server-internal/README.md new file mode 100644 index 0000000000000..669a7a428e0ac --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/README.md @@ -0,0 +1,4 @@ +# @kbn/core-analytics-server-internal + +This package contains the internal types and implementation for Core's server-side analytics service. + diff --git a/packages/core/analytics/core-analytics-server-internal/jest.config.js b/packages/core/analytics/core-analytics-server-internal/jest.config.js new file mode 100644 index 0000000000000..d124015992400 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/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/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/analytics/core-analytics-server-internal'], +}; diff --git a/packages/core/analytics/core-analytics-server-internal/package.json b/packages/core/analytics/core-analytics-server-internal/package.json new file mode 100644 index 0000000000000..12dc15e9633a4 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-analytics-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/analytics/analytics_service.ts b/packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts similarity index 85% rename from src/core/server/analytics/analytics_service.ts rename to packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts index 7d091f5744800..0fa96ebe0ae51 100644 --- a/src/core/server/analytics/analytics_service.ts +++ b/packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts @@ -10,28 +10,11 @@ import { of } from 'rxjs'; import type { AnalyticsClient } from '@kbn/analytics-client'; import { createAnalytics } from '@kbn/analytics-client'; import type { CoreContext } from '@kbn/core-base-server-internal'; - -/** - * Exposes the public APIs of the AnalyticsClient during the preboot phase - * {@link AnalyticsClient} - * @public - */ -export type AnalyticsServicePreboot = Omit; -/** - * Exposes the public APIs of the AnalyticsClient during the setup phase. - * {@link AnalyticsClient} - * @public - */ -export type AnalyticsServiceSetup = Omit; -/** - * Exposes the public APIs of the AnalyticsClient during the start phase - * {@link AnalyticsClient} - * @public - */ -export type AnalyticsServiceStart = Pick< - AnalyticsClient, - 'optIn' | 'reportEvent' | 'telemetryCounter$' ->; +import type { + AnalyticsServiceSetup, + AnalyticsServiceStart, + AnalyticsServicePreboot, +} from '@kbn/core-analytics-server'; export class AnalyticsService { private readonly analyticsClient: AnalyticsClient; @@ -59,6 +42,7 @@ export class AnalyticsService { telemetryCounter$: this.analyticsClient.telemetryCounter$, }; } + public setup(): AnalyticsServiceSetup { return { optIn: this.analyticsClient.optIn, @@ -70,6 +54,7 @@ export class AnalyticsService { telemetryCounter$: this.analyticsClient.telemetryCounter$, }; } + public start(): AnalyticsServiceStart { return { optIn: this.analyticsClient.optIn, diff --git a/packages/core/analytics/core-analytics-server-internal/src/index.ts b/packages/core/analytics/core-analytics-server-internal/src/index.ts new file mode 100644 index 0000000000000..23048526a8e70 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/src/index.ts @@ -0,0 +1,9 @@ +/* + * 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 { AnalyticsService } from './analytics_service'; diff --git a/packages/core/analytics/core-analytics-server-internal/tsconfig.json b/packages/core/analytics/core-analytics-server-internal/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/analytics/core-analytics-server-mocks/BUILD.bazel b/packages/core/analytics/core-analytics-server-mocks/BUILD.bazel new file mode 100644 index 0000000000000..21f95820735f4 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/BUILD.bazel @@ -0,0 +1,100 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-analytics-server-mocks" +PKG_REQUIRE_NAME = "@kbn/core-analytics-server-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//rxjs", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//rxjs", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/analytics/core-analytics-server:npm_module_types", + "//packages/core/analytics/core-analytics-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/analytics/core-analytics-server-mocks/README.md b/packages/core/analytics/core-analytics-server-mocks/README.md new file mode 100644 index 0000000000000..1b94135affb9b --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/README.md @@ -0,0 +1,4 @@ +# @kbn/core-analytics-server-mocks + +This package contains the mocks for Core's server-side analytics service. + diff --git a/packages/core/analytics/core-analytics-server-mocks/jest.config.js b/packages/core/analytics/core-analytics-server-mocks/jest.config.js new file mode 100644 index 0000000000000..5206ddb7da156 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/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/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/analytics/core-analytics-server-mocks'], +}; diff --git a/packages/core/analytics/core-analytics-server-mocks/package.json b/packages/core/analytics/core-analytics-server-mocks/package.json new file mode 100644 index 0000000000000..12b50433e7f62 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-analytics-server-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/analytics/analytics_service.mock.ts b/packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts similarity index 94% rename from src/core/server/analytics/analytics_service.mock.ts rename to packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts index 7a00e573f3e7b..44d3d04f25279 100644 --- a/src/core/server/analytics/analytics_service.mock.ts +++ b/packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts @@ -6,14 +6,14 @@ * Side Public License, v 1. */ +import { Subject } from 'rxjs'; import type { PublicMethodsOf } from '@kbn/utility-types'; import type { - AnalyticsService, - AnalyticsServicePreboot, AnalyticsServiceSetup, AnalyticsServiceStart, -} from './analytics_service'; -import { Subject } from 'rxjs'; + AnalyticsServicePreboot, +} from '@kbn/core-analytics-server'; +import type { AnalyticsService } from '@kbn/core-analytics-server-internal'; type AnalyticsServiceContract = PublicMethodsOf; diff --git a/packages/core/analytics/core-analytics-server-mocks/src/index.ts b/packages/core/analytics/core-analytics-server-mocks/src/index.ts new file mode 100644 index 0000000000000..0cf55aeb9a349 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/src/index.ts @@ -0,0 +1,9 @@ +/* + * 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 { analyticsServiceMock } from './analytics_service.mock'; diff --git a/packages/core/analytics/core-analytics-server-mocks/tsconfig.json b/packages/core/analytics/core-analytics-server-mocks/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/analytics/core-analytics-server-mocks/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/analytics/core-analytics-server/BUILD.bazel b/packages/core/analytics/core-analytics-server/BUILD.bazel new file mode 100644 index 0000000000000..e59378e010127 --- /dev/null +++ b/packages/core/analytics/core-analytics-server/BUILD.bazel @@ -0,0 +1,96 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-analytics-server" +PKG_REQUIRE_NAME = "@kbn/core-analytics-server" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/analytics/client:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/analytics/core-analytics-server/README.md b/packages/core/analytics/core-analytics-server/README.md new file mode 100644 index 0000000000000..065d26a1d649c --- /dev/null +++ b/packages/core/analytics/core-analytics-server/README.md @@ -0,0 +1,4 @@ +# @kbn/core-analytics-server + +This package contains the public types for Core's server-side analytics service. + diff --git a/packages/core/analytics/core-analytics-server/jest.config.js b/packages/core/analytics/core-analytics-server/jest.config.js new file mode 100644 index 0000000000000..6b1d4596c8eb2 --- /dev/null +++ b/packages/core/analytics/core-analytics-server/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/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/analytics/core-analytics-server'], +}; diff --git a/packages/core/analytics/core-analytics-server/package.json b/packages/core/analytics/core-analytics-server/package.json new file mode 100644 index 0000000000000..f990017e75c39 --- /dev/null +++ b/packages/core/analytics/core-analytics-server/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-analytics-server", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/analytics/core-analytics-server/src/contracts.ts b/packages/core/analytics/core-analytics-server/src/contracts.ts new file mode 100644 index 0000000000000..1b297b197374d --- /dev/null +++ b/packages/core/analytics/core-analytics-server/src/contracts.ts @@ -0,0 +1,33 @@ +/* + * 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. + */ + +import type { AnalyticsClient } from '@kbn/analytics-client'; + +/** + * Exposes the public APIs of the AnalyticsClient during the preboot phase + * {@link AnalyticsClient} + * @public + */ +export type AnalyticsServicePreboot = Omit; + +/** + * Exposes the public APIs of the AnalyticsClient during the setup phase. + * {@link AnalyticsClient} + * @public + */ +export type AnalyticsServiceSetup = Omit; + +/** + * Exposes the public APIs of the AnalyticsClient during the start phase + * {@link AnalyticsClient} + * @public + */ +export type AnalyticsServiceStart = Pick< + AnalyticsClient, + 'optIn' | 'reportEvent' | 'telemetryCounter$' +>; diff --git a/packages/core/analytics/core-analytics-server/src/index.ts b/packages/core/analytics/core-analytics-server/src/index.ts new file mode 100644 index 0000000000000..b070f744f831f --- /dev/null +++ b/packages/core/analytics/core-analytics-server/src/index.ts @@ -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. + */ + +export type { + AnalyticsServiceSetup, + AnalyticsServiceStart, + AnalyticsServicePreboot, +} from './contracts'; diff --git a/packages/core/analytics/core-analytics-server/tsconfig.json b/packages/core/analytics/core-analytics-server/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/analytics/core-analytics-server/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/src/core/server/errors.ts b/packages/core/base/core-base-server-internal/src/errors.ts similarity index 100% rename from src/core/server/errors.ts rename to packages/core/base/core-base-server-internal/src/errors.ts diff --git a/packages/core/base/core-base-server-internal/src/index.ts b/packages/core/base/core-base-server-internal/src/index.ts index 2cfa86145ce7b..ddf7a27886484 100644 --- a/packages/core/base/core-base-server-internal/src/index.ts +++ b/packages/core/base/core-base-server-internal/src/index.ts @@ -8,3 +8,4 @@ export type { CoreContext } from './core_context'; export type { CoreService, ServiceConfigDescriptor } from './services'; +export { CriticalError } from './errors'; diff --git a/packages/core/config/core-config-server-internal/BUILD.bazel b/packages/core/config/core-config-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..e05a2c280a063 --- /dev/null +++ b/packages/core/config/core-config-server-internal/BUILD.bazel @@ -0,0 +1,103 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-config-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-config-server-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "//packages/elastic-safer-lodash-set", + "//packages/kbn-config", + "//packages/core/base/core-base-server-internal", + "//packages/kbn-config-mocks", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/elastic-safer-lodash-set:npm_module_types", + "//packages/kbn-config:npm_module_types", + "//packages/kbn-config-mocks:npm_module_types", + "//packages/core/base/core-base-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/config/core-config-server-internal/README.md b/packages/core/config/core-config-server-internal/README.md new file mode 100644 index 0000000000000..157f5cc4727b6 --- /dev/null +++ b/packages/core/config/core-config-server-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-config-server-internal + +This package contains the internal types and implementation for Core's server-side configuration. diff --git a/packages/core/config/core-config-server-internal/jest.config.js b/packages/core/config/core-config-server-internal/jest.config.js new file mode 100644 index 0000000000000..2ec41b98be493 --- /dev/null +++ b/packages/core/config/core-config-server-internal/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/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/config/core-config-server-internal'], +}; diff --git a/packages/core/config/core-config-server-internal/package.json b/packages/core/config/core-config-server-internal/package.json new file mode 100644 index 0000000000000..92cdc3fe27d1f --- /dev/null +++ b/packages/core/config/core-config-server-internal/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-config-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/config/deprecation/core_deprecations.test.ts b/packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.test.ts similarity index 100% rename from src/core/server/config/deprecation/core_deprecations.test.ts rename to packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.test.ts diff --git a/src/core/server/config/deprecation/core_deprecations.ts b/packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.ts similarity index 96% rename from src/core/server/config/deprecation/core_deprecations.ts rename to packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.ts index 2c30ab490db65..237ba1f5e8493 100644 --- a/src/core/server/config/deprecation/core_deprecations.ts +++ b/packages/core/config/core-config-server-internal/src/deprecation/core_deprecations.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { ConfigDeprecationProvider, ConfigDeprecation } from '@kbn/config'; +import type { ConfigDeprecationProvider, ConfigDeprecation } from '@kbn/config'; const rewriteBasePathDeprecation: ConfigDeprecation = (settings, fromPath, addDeprecation) => { if (settings.server?.basePath && !settings.server?.rewriteBasePath) { diff --git a/src/core/server/config/deprecation/index.ts b/packages/core/config/core-config-server-internal/src/deprecation/index.ts similarity index 100% rename from src/core/server/config/deprecation/index.ts rename to packages/core/config/core-config-server-internal/src/deprecation/index.ts diff --git a/src/core/server/config/ensure_valid_configuration.test.ts b/packages/core/config/core-config-server-internal/src/ensure_valid_configuration.test.ts similarity index 98% rename from src/core/server/config/ensure_valid_configuration.test.ts rename to packages/core/config/core-config-server-internal/src/ensure_valid_configuration.test.ts index 9161ffefaf5d3..c2ed9523c5050 100644 --- a/src/core/server/config/ensure_valid_configuration.test.ts +++ b/packages/core/config/core-config-server-internal/src/ensure_valid_configuration.test.ts @@ -8,7 +8,7 @@ import { configServiceMock } from '@kbn/config-mocks'; import { ensureValidConfiguration } from './ensure_valid_configuration'; -import { CriticalError } from '../errors'; +import { CriticalError } from '@kbn/core-base-server-internal'; describe('ensureValidConfiguration', () => { let configService: ReturnType; diff --git a/src/core/server/config/ensure_valid_configuration.ts b/packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts similarity index 95% rename from src/core/server/config/ensure_valid_configuration.ts rename to packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts index 040cb23e07988..ddf4573b8de22 100644 --- a/src/core/server/config/ensure_valid_configuration.ts +++ b/packages/core/config/core-config-server-internal/src/ensure_valid_configuration.ts @@ -7,7 +7,7 @@ */ import { ConfigService, ConfigValidateParameters } from '@kbn/config'; -import { CriticalError } from '../errors'; +import { CriticalError } from '@kbn/core-base-server-internal'; const ignoredPaths = ['dev.', 'elastic.apm.']; diff --git a/packages/core/config/core-config-server-internal/src/index.ts b/packages/core/config/core-config-server-internal/src/index.ts new file mode 100644 index 0000000000000..cefac583eb249 --- /dev/null +++ b/packages/core/config/core-config-server-internal/src/index.ts @@ -0,0 +1,11 @@ +/* + * 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 { coreDeprecationProvider } from './deprecation'; +export { ensureValidConfiguration } from './ensure_valid_configuration'; +export { getDeprecationsFor, getDeprecationsForGlobalSettings } from './test_utils'; diff --git a/src/core/server/config/test_utils.ts b/packages/core/config/core-config-server-internal/src/test_utils.ts similarity index 100% rename from src/core/server/config/test_utils.ts rename to packages/core/config/core-config-server-internal/src/test_utils.ts diff --git a/packages/core/config/core-config-server-internal/tsconfig.json b/packages/core/config/core-config-server-internal/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/config/core-config-server-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/i18n/core-i18n-browser-internal/BUILD.bazel b/packages/core/i18n/core-i18n-browser-internal/BUILD.bazel new file mode 100644 index 0000000000000..edc404266491b --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/BUILD.bazel @@ -0,0 +1,110 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-i18n-browser-internal" +PKG_REQUIRE_NAME = "@kbn/core-i18n-browser-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/__snapshots__/**/*", + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + '//packages/kbn-i18n-react' +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/react", + "//packages/kbn-i18n:npm_module_types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/core/injected-metadata/core-injected-metadata-browser-internal:npm_module_types", + "//packages/core/i18n/core-i18n-browser:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/i18n/core-i18n-browser-internal/README.md b/packages/core/i18n/core-i18n-browser-internal/README.md new file mode 100644 index 0000000000000..a222a9317cdbb --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-i18n-browser-internal + +This package contains the internal types and implementation for the i18n service. \ No newline at end of file diff --git a/packages/core/i18n/core-i18n-browser-internal/jest.config.js b/packages/core/i18n/core-i18n-browser-internal/jest.config.js new file mode 100644 index 0000000000000..573f9f6c6c598 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/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/core/i18n/core-i18n-browser-internal'], +}; diff --git a/packages/core/i18n/core-i18n-browser-internal/package.json b/packages/core/i18n/core-i18n-browser-internal/package.json new file mode 100644 index 0000000000000..ceb27969df9c5 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-i18n-browser-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap b/packages/core/i18n/core-i18n-browser-internal/src/__snapshots__/i18n_service.test.tsx.snap similarity index 99% rename from src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap rename to packages/core/i18n/core-i18n-browser-internal/src/__snapshots__/i18n_service.test.tsx.snap index 54b5c40a8cc18..e3e761425c1ee 100644 --- a/src/core/public/i18n/__snapshots__/i18n_service.test.tsx.snap +++ b/packages/core/i18n/core-i18n-browser-internal/src/__snapshots__/i18n_service.test.tsx.snap @@ -66,6 +66,7 @@ exports[`#start() returns \`Context\` component 1`] = ` "euiColumnSortingDraggable.activeSortLabel": [Function], "euiColumnSortingDraggable.defaultSortAsc": "A-Z", "euiColumnSortingDraggable.defaultSortDesc": "Z-A", + "euiColumnSortingDraggable.dragHandleAriaLabel": "Drag handle", "euiColumnSortingDraggable.removeSortLabel": [Function], "euiColumnSortingDraggable.toggleLegend": [Function], "euiComboBox.listboxAriaLabel": "Choose from the following options", diff --git a/src/core/public/i18n/i18n_eui_mapping.test.ts b/packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.test.ts similarity index 97% rename from src/core/public/i18n/i18n_eui_mapping.test.ts rename to packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.test.ts index a2d35b37ac569..2520e06b20242 100644 --- a/src/core/public/i18n/i18n_eui_mapping.test.ts +++ b/packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.test.ts @@ -15,6 +15,10 @@ import { getEuiContextMapping } from './i18n_eui_mapping'; /** Regexp to find {values} usage */ const VALUES_REGEXP = /\{\w+\}/; +type I18nTranslateCall = [ + string, + { defaultMessage: string; values?: object; description?: string } +]; describe('@elastic/eui i18n tokens', () => { const i18nTranslateActual = jest.requireActual('@kbn/i18n').i18n.translate; @@ -47,11 +51,7 @@ describe('@elastic/eui i18n tokens', () => { i18ntokens.forEach(({ token, defString }) => { describe(`Token "${token}"`, () => { - let i18nTranslateCall: [ - string, - { defaultMessage: string; values?: object; description?: string } - ]; - + let i18nTranslateCall: I18nTranslateCall; beforeAll(() => { // If it's a function, call it, so we have the mock to register the call. const entry = euiContextMapping[token as keyof typeof euiContextMapping]; diff --git a/src/core/public/i18n/i18n_eui_mapping.tsx b/packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.tsx similarity index 99% rename from src/core/public/i18n/i18n_eui_mapping.tsx rename to packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.tsx index 098d617852576..899fb1c12171d 100644 --- a/src/core/public/i18n/i18n_eui_mapping.tsx +++ b/packages/core/i18n/core-i18n-browser-internal/src/i18n_eui_mapping.tsx @@ -306,6 +306,12 @@ export const getEuiContextMapping = (): EuiTokensObject => { defaultMessage: 'Select sorting method for {display}', values: { display }, }), + 'euiColumnSortingDraggable.dragHandleAriaLabel': i18n.translate( + 'core.euiColumnSortingDraggable.dragHandleAriaLabel', + { + defaultMessage: 'Drag handle', + } + ), 'euiComboBox.listboxAriaLabel': i18n.translate('core.euiComboBox.listboxAriaLabel', { defaultMessage: 'Choose from the following options', }), diff --git a/src/core/public/i18n/i18n_service.test.tsx b/packages/core/i18n/core-i18n-browser-internal/src/i18n_service.test.tsx similarity index 100% rename from src/core/public/i18n/i18n_service.test.tsx rename to packages/core/i18n/core-i18n-browser-internal/src/i18n_service.test.tsx diff --git a/src/core/public/i18n/i18n_service.tsx b/packages/core/i18n/core-i18n-browser-internal/src/i18n_service.tsx similarity index 76% rename from src/core/public/i18n/i18n_service.tsx rename to packages/core/i18n/core-i18n-browser-internal/src/i18n_service.tsx index 640dec6321184..c42662ae9cd32 100644 --- a/src/core/public/i18n/i18n_service.tsx +++ b/packages/core/i18n/core-i18n-browser-internal/src/i18n_service.tsx @@ -10,6 +10,7 @@ import React from 'react'; import { EuiContext } from '@elastic/eui'; import { I18nProvider } from '@kbn/i18n-react'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { getEuiContextMapping } from './i18n_eui_mapping'; /** @@ -50,17 +51,3 @@ export class I18nService { // nothing to do here currently } } - -/** - * I18nStart.Context is required by any localizable React component from \@kbn/i18n and \@elastic/eui packages - * and is supposed to be used as the topmost component for any i18n-compatible React tree. - * - * @public - * - */ -export interface I18nStart { - /** - * React Context provider required as the topmost component for any i18n-compatible React tree. - */ - Context: ({ children }: { children: React.ReactNode }) => JSX.Element; -} diff --git a/packages/core/i18n/core-i18n-browser-internal/src/index.ts b/packages/core/i18n/core-i18n-browser-internal/src/index.ts new file mode 100644 index 0000000000000..6c2bc79fe50b7 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/src/index.ts @@ -0,0 +1,9 @@ +/* + * 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 { I18nService } from './i18n_service'; diff --git a/packages/core/i18n/core-i18n-browser-internal/tsconfig.json b/packages/core/i18n/core-i18n-browser-internal/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/i18n/core-i18n-browser-mocks/BUILD.bazel b/packages/core/i18n/core-i18n-browser-mocks/BUILD.bazel new file mode 100644 index 0000000000000..4a3b9ec38e879 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/BUILD.bazel @@ -0,0 +1,109 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-i18n-browser-mocks" +PKG_REQUIRE_NAME = "@kbn/core-i18n-browser-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "//packages/core/injected-metadata/core-injected-metadata-browser-mocks", + "//packages/core/i18n/core-i18n-browser-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/injected-metadata/core-injected-metadata-browser-mocks:npm_module_types", + "//packages/core/i18n/core-i18n-browser:npm_module_types", + "//packages/core/i18n/core-i18n-browser-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/i18n/core-i18n-browser-mocks/README.md b/packages/core/i18n/core-i18n-browser-mocks/README.md new file mode 100644 index 0000000000000..18275d785215e --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-i18n-browser-mocks + +This package contains the mocks for Core's browser-side i18n service. diff --git a/packages/core/i18n/core-i18n-browser-mocks/jest.config.js b/packages/core/i18n/core-i18n-browser-mocks/jest.config.js new file mode 100644 index 0000000000000..3e15cf7870c1a --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/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/core/i18n/core-i18n-browser-mocks'], +}; diff --git a/packages/core/i18n/core-i18n-browser-mocks/package.json b/packages/core/i18n/core-i18n-browser-mocks/package.json new file mode 100644 index 0000000000000..45424b4938ade --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-i18n-browser-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/i18n/i18n_service.mock.ts b/packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts similarity index 91% rename from src/core/public/i18n/i18n_service.mock.ts rename to packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts index be28a2d565cb2..ed4e4891ff1d7 100644 --- a/src/core/public/i18n/i18n_service.mock.ts +++ b/packages/core/i18n/core-i18n-browser-mocks/src/i18n_service.mock.ts @@ -8,8 +8,8 @@ import React from 'react'; import type { PublicMethodsOf } from '@kbn/utility-types'; - -import { I18nService, I18nStart } from './i18n_service'; +import { I18nService } from '@kbn/core-i18n-browser-internal'; +import type { I18nStart } from '@kbn/core-i18n-browser'; const PassThroughComponent = ({ children }: { children: React.ReactNode }) => children; diff --git a/packages/core/i18n/core-i18n-browser-mocks/src/index.ts b/packages/core/i18n/core-i18n-browser-mocks/src/index.ts new file mode 100644 index 0000000000000..2d174cdf989aa --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/src/index.ts @@ -0,0 +1,9 @@ +/* + * 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 { i18nServiceMock } from './i18n_service.mock'; diff --git a/packages/core/i18n/core-i18n-browser-mocks/tsconfig.json b/packages/core/i18n/core-i18n-browser-mocks/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser-mocks/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/i18n/core-i18n-browser/BUILD.bazel b/packages/core/i18n/core-i18n-browser/BUILD.bazel new file mode 100644 index 0000000000000..6c44bae7866b0 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/BUILD.bazel @@ -0,0 +1,105 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-i18n-browser" +PKG_REQUIRE_NAME = "@kbn/core-i18n-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/react", + "//packages/kbn-i18n:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/i18n/core-i18n-browser/README.md b/packages/core/i18n/core-i18n-browser/README.md new file mode 100644 index 0000000000000..f7a31f0b471c3 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/core-i18n-browser + +This package contains the public types for Core's browser-side i18n service. diff --git a/packages/core/i18n/core-i18n-browser/jest.config.js b/packages/core/i18n/core-i18n-browser/jest.config.js new file mode 100644 index 0000000000000..c2d008e3eec5f --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/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/core/i18n/core-i18n-browser'], +}; diff --git a/packages/core/i18n/core-i18n-browser/package.json b/packages/core/i18n/core-i18n-browser/package.json new file mode 100644 index 0000000000000..88382aca19615 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-i18n-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/i18n/core-i18n-browser/src/index.ts b/packages/core/i18n/core-i18n-browser/src/index.ts new file mode 100644 index 0000000000000..53a4a886bd5d3 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/src/index.ts @@ -0,0 +1,9 @@ +/* + * 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 type { I18nStart } from './types'; diff --git a/packages/core/i18n/core-i18n-browser/src/types.ts b/packages/core/i18n/core-i18n-browser/src/types.ts new file mode 100644 index 0000000000000..3d469bf9d458e --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/src/types.ts @@ -0,0 +1,22 @@ +/* + * 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. + */ + +import React from 'react'; + +/** + * I18nStart.Context is required by any localizable React component from \@kbn/i18n and \@elastic/eui packages + * and is supposed to be used as the topmost component for any i18n-compatible React tree. + * + * @public + */ +export interface I18nStart { + /** + * React Context provider required as the topmost component for any i18n-compatible React tree. + */ + Context: ({ children }: { children: React.ReactNode }) => JSX.Element; +} diff --git a/packages/core/i18n/core-i18n-browser/tsconfig.json b/packages/core/i18n/core-i18n-browser/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/i18n/core-i18n-browser/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.tsx b/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.tsx index 975c201ba3097..82264534ab554 100644 --- a/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.tsx +++ b/packages/core/theme/core-theme-browser-internal/src/core_theme_provider.tsx @@ -28,6 +28,7 @@ const emotionCache = createCache({ key: 'eui-styles', container: document.querySelector(`meta[name="${EUI_STYLES_GLOBAL}"]`) as HTMLElement, }); +emotionCache.compat = true; /** * Wrapper around `EuiProvider` converting (and exposing) core's theme to EUI theme. diff --git a/packages/kbn-bazel-packages/src/bazel_package_dirs.ts b/packages/kbn-bazel-packages/src/bazel_package_dirs.ts index 5c0bfb5d4595b..ed295cffd7ede 100644 --- a/packages/kbn-bazel-packages/src/bazel_package_dirs.ts +++ b/packages/kbn-bazel-packages/src/bazel_package_dirs.ts @@ -27,6 +27,7 @@ export const BAZEL_PACKAGE_DIRS = [ 'packages/analytics/shippers', 'packages/analytics/shippers/elastic_v3', 'packages/core/*', + 'x-pack/packages/ml', ]; /** diff --git a/packages/kbn-ci-stats-performance-metrics/BUILD.bazel b/packages/kbn-ci-stats-performance-metrics/BUILD.bazel new file mode 100644 index 0000000000000..ff475252a3e99 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/BUILD.bazel @@ -0,0 +1,124 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-ci-stats-performance-metrics" +PKG_REQUIRE_NAME = "@kbn/ci-stats-performance-metrics" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "//packages/kbn-dev-cli-errors", + "//packages/kbn-dev-cli-runner", + "//packages/kbn-test", + "//packages/kbn-tooling-log", + "//packages/kbn-ci-stats-reporter", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "//packages/kbn-dev-cli-errors:npm_module_types", + "//packages/kbn-dev-cli-runner:npm_module_types", + "//packages/kbn-test:npm_module_types", + "//packages/kbn-tooling-log:npm_module_types", + "//packages/kbn-ci-stats-reporter:npm_module_types", + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-ci-stats-performance-metrics/README.md b/packages/kbn-ci-stats-performance-metrics/README.md new file mode 100644 index 0000000000000..8b1390e8dc7ab --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/README.md @@ -0,0 +1,3 @@ +# @kbn/ci-stats-performance-metrics + +Empty package generated by @kbn/generate diff --git a/packages/kbn-ci-stats-performance-metrics/jest.config.js b/packages/kbn-ci-stats-performance-metrics/jest.config.js new file mode 100644 index 0000000000000..98fc60a9a052a --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/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/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-ci-stats-performance-metrics'], +}; diff --git a/packages/kbn-ci-stats-performance-metrics/package.json b/packages/kbn-ci-stats-performance-metrics/package.json new file mode 100644 index 0000000000000..0801174ab4a02 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/ci-stats-performance-metrics", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/kbn-ci-stats-performance-metrics/src/apm_client.ts b/packages/kbn-ci-stats-performance-metrics/src/apm_client.ts new file mode 100644 index 0000000000000..ac72b79dc5fb4 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/src/apm_client.ts @@ -0,0 +1,98 @@ +/* + * 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. + */ + +import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'; +import { ToolingLog } from '@kbn/tooling-log'; +import { getYearAgoIso } from './utils'; + +type Environment = 'ENVIRONMENT_ALL' | 'ci' | 'development'; +type LatencyAggregationType = 'avg' | 'p95' | 'p99'; +type TransactionType = 'page-load' | 'app-change' | 'user-interaction' | 'http-request'; + +interface MainStatisticsRequestOptions { + ciBuildId: string; + start?: string; + end?: string; + environment?: Environment; + transactionType?: TransactionType; + latencyAggregationType?: LatencyAggregationType; +} + +export interface TransactionGroup { + name: string; + latency: number; + throughput: number; + errorRate?: any; + impact: number; + transactionType: TransactionType; +} + +export interface MainStatisticsResponse { + transactionGroups: TransactionGroup[]; + isAggregationAccurate: boolean; + bucketSize: number; +} + +const DEFAULT_BASE_URL = + 'https://kibana-ops-e2e-perf.kb.us-central1.gcp.cloud.es.io:9243/internal/apm'; +const DEFAULT_CLIENT_TIMEOUT = 120 * 1000; + +export class ApmClient { + private readonly client: AxiosInstance; + private readonly logger: ToolingLog; + + constructor(config: AxiosRequestConfig, logger: ToolingLog) { + const { baseURL = DEFAULT_BASE_URL, timeout = DEFAULT_CLIENT_TIMEOUT, auth } = config; + + this.client = axios.create({ + auth, + baseURL, + timeout, + }); + + this.logger = logger || console; + } + + public get baseUrl(): string | undefined { + return this.client.defaults.baseURL; + } + + public async mainStatistics(queryParams: MainStatisticsRequestOptions) { + const { now, yearAgo } = getYearAgoIso(); + + const { + ciBuildId, + start = yearAgo, + end = now, + environment = 'ENVIRONMENT_ALL', + transactionType = 'page-load', + latencyAggregationType = 'avg', + } = queryParams; + + try { + const responseRaw = await this.client.get( + `services/kibana-frontend/transactions/groups/main_statistics`, + { + params: { + kuery: `labels.ciBuildId:${ciBuildId}`, + environment, + start, + end, + transactionType, + latencyAggregationType, + }, + } + ); + return responseRaw.data; + } catch (error) { + this.logger.error( + `Error fetching main statistics from APM, ci build ${ciBuildId}, error message ${error.message}` + ); + } + } +} diff --git a/packages/kbn-ci-stats-performance-metrics/src/cli.ts b/packages/kbn-ci-stats-performance-metrics/src/cli.ts new file mode 100644 index 0000000000000..49af12a48bb19 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/src/cli.ts @@ -0,0 +1,81 @@ +/* + * 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. + */ + +/** *********************************************************** + * + * Run `node scripts/extract_performance_testing_dataset --help` for usage information + * + *************************************************************/ + +import { run } from '@kbn/dev-cli-runner'; +import { createFlagError } from '@kbn/dev-cli-errors'; +import { reporter } from './reporter'; + +export async function runCli() { + run( + async ({ log, flags }) => { + const apmBaseUrl = flags['apm-url']; + if (apmBaseUrl && typeof apmBaseUrl !== 'string') { + throw createFlagError('--apm-url must be a string'); + } + if (!apmBaseUrl) { + throw createFlagError('--apm-url must be defined'); + } + + const apmUsername = flags['apm-username']; + if (apmUsername && typeof apmUsername !== 'string') { + throw createFlagError('--apm-username must be a string'); + } + if (!apmUsername) { + throw createFlagError('--apm-username must be defined'); + } + + const apmPassword = flags['apm-password']; + if (apmPassword && typeof apmPassword !== 'string') { + throw createFlagError('--apm-password must be a string'); + } + if (!apmPassword) { + throw createFlagError('--apm-password must be defined'); + } + + const buildId = flags.buildId; + if (buildId && typeof buildId !== 'string') { + throw createFlagError('--buildId must be a string'); + } + if (!buildId) { + throw createFlagError('--buildId must be defined'); + } + + return reporter({ + apmClient: { + auth: { + username: apmUsername, + password: apmPassword, + }, + baseURL: apmBaseUrl, + }, + param: { + ciBuildId: buildId, + }, + log, + }); + }, + { + description: `CLI to fetch performance metrics and report those to ci-stats`, + flags: { + string: ['buildId', 'apm-url', 'apm-username', 'apm-password'], + help: ` + --buildId BUILDKITE_JOB_ID or uuid generated locally, stored in APM-based document as label: 'labels.testBuildId' + --apm-url url for APM cluster + --apm-username username for Apm + --apm-password password for Apm + `, + }, + } + ); +} diff --git a/packages/kbn-ci-stats-performance-metrics/src/index.ts b/packages/kbn-ci-stats-performance-metrics/src/index.ts new file mode 100644 index 0000000000000..0da7aee1a6ef2 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/src/index.ts @@ -0,0 +1,10 @@ +/* + * 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 { reporter } from './reporter'; +export { runCli } from './cli'; diff --git a/packages/kbn-ci-stats-performance-metrics/src/reporter.ts b/packages/kbn-ci-stats-performance-metrics/src/reporter.ts new file mode 100644 index 0000000000000..904eff2393e96 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/src/reporter.ts @@ -0,0 +1,56 @@ +/* + * 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. + */ + +import { ToolingLog } from '@kbn/tooling-log'; +import { CiStatsReporter } from '@kbn/ci-stats-reporter'; + +import { ApmClient } from './apm_client'; + +interface ReporterOptions { + param: { + ciBuildId: string; + }; + apmClient: { + baseURL: string; + auth: { + username: string; + password: string; + }; + }; + log: ToolingLog; +} + +export async function reporter(options: ReporterOptions) { + const { + param: { ciBuildId }, + apmClient: apmClientOptions, + log, + } = options; + + const apm = new ApmClient(apmClientOptions, log); + + const performanceMainStats = await apm.mainStatistics({ ciBuildId }); + + if (performanceMainStats) { + const { transactionGroups: tg } = performanceMainStats; + + const loginStats = tg.find((e) => e.name === '/login'); + const appHomeStats = tg.find((e) => e.name === '/app/home'); + const appDashboardsStats = tg.find((e) => e.name === '/app/dashboards'); + + const ciStatsReporter = CiStatsReporter.fromEnv(log); + + const body = { + ...(loginStats && { page_load_login: loginStats.latency }), + ...(appHomeStats && { page_load_app_home: appHomeStats.latency }), + ...(appDashboardsStats && { page_load_app_dashboards: appDashboardsStats.latency }), + }; + + await ciStatsReporter.reportPerformanceMetrics(body); + } +} diff --git a/packages/kbn-ci-stats-performance-metrics/src/utils.ts b/packages/kbn-ci-stats-performance-metrics/src/utils.ts new file mode 100644 index 0000000000000..bd22c0569b247 --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/src/utils.ts @@ -0,0 +1,19 @@ +/* + * 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 function getYearAgoIso() { + const d = new Date(); + const nowIso = d.toISOString(); + d.setMonth(d.getMonth() - 12); + const yearAgoIso = d.toISOString(); + + return { + now: nowIso, + yearAgo: yearAgoIso, + }; +} diff --git a/packages/kbn-ci-stats-performance-metrics/tsconfig.json b/packages/kbn-ci-stats-performance-metrics/tsconfig.json new file mode 100644 index 0000000000000..a8cfc2cceb08b --- /dev/null +++ b/packages/kbn-ci-stats-performance-metrics/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts index 5d3f17a76f687..7a23f20143d94 100644 --- a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts +++ b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts @@ -57,6 +57,8 @@ export interface CiStatsMetric { meta?: CiStatsMetadata; } +export type PerformanceMetrics = Record; + /** A ci-stats timing event */ export interface CiStatsTiming { /** Top-level categorization for the timing, e.g. "scripts/foo", process type, etc. */ @@ -306,6 +308,24 @@ export class CiStatsReporter { } } + async reportPerformanceMetrics(metrics: PerformanceMetrics) { + if (!this.hasBuildConfig()) { + return; + } + + const buildId = this.config?.buildId; + if (!buildId) { + throw new Error(`Performance metrics can't be reported without a buildId`); + } + + return !!(await this.req({ + auth: true, + path: `/v1/performance_metrics_report?buildId=${buildId}`, + body: { metrics }, + bodyDesc: `performance metrics: ${metrics}`, + })); + } + /** * In order to allow this code to run before @kbn/utils is built, @kbn/pm will pass * in the upstreamBranch when calling the timings() method. Outside of @kbn/pm diff --git a/packages/kbn-es-query/src/es_query/build_es_query.test.ts b/packages/kbn-es-query/src/es_query/build_es_query.test.ts index 8fd884f65fa0d..a75c8d3d3a03f 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.test.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.test.ts @@ -202,5 +202,60 @@ describe('build query', () => { expect(result).toEqual(expectedResult); }); + + it('should allow to use ignore_unmapped for nested fields', () => { + const queries = [ + { query: 'nestedField: { child: "something" }', language: 'kuery' }, + ] as Query[]; + + const filters = [ + { + query: { exists: { field: 'nestedField.child' } }, + meta: { type: 'exists', alias: '', disabled: false, negate: false }, + }, + ]; + + const result = buildEsQuery(indexPattern, queries, filters, { nestedIgnoreUnmapped: true }); + const expected = { + bool: { + must: [], + filter: [ + { + nested: { + ignore_unmapped: true, + path: 'nestedField', + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + 'nestedField.child': 'something', + }, + }, + ], + }, + }, + score_mode: 'none', + }, + }, + { + nested: { + path: 'nestedField', + query: { + exists: { + field: 'nestedField.child', + }, + }, + ignore_unmapped: true, + }, + }, + ], + should: [], + must_not: [], + }, + }; + expect(result).toEqual(expected); + }); }); }); diff --git a/packages/kbn-es-query/src/es_query/build_es_query.ts b/packages/kbn-es-query/src/es_query/build_es_query.ts index 0ae0b8799b026..62172fa5aa4d8 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.ts @@ -13,17 +13,18 @@ import { buildQueryFromFilters } from './from_filters'; import { buildQueryFromLucene } from './from_lucene'; import { Filter, Query } from '../filters'; import { BoolQuery, DataViewBase } from './types'; -import { KueryQueryOptions } from '../kuery'; +import type { KueryQueryOptions } from '../kuery'; +import type { EsQueryFiltersConfig } from './from_filters'; /** * Configurations to be used while constructing an ES query. * @public */ -export type EsQueryConfig = KueryQueryOptions & { - allowLeadingWildcards: boolean; - queryStringOptions: SerializableRecord; - ignoreFilterIfFieldNotInIndex: boolean; -}; +export type EsQueryConfig = KueryQueryOptions & + EsQueryFiltersConfig & { + allowLeadingWildcards?: boolean; + queryStringOptions?: SerializableRecord; + }; function removeMatchAll(filters: T[]) { return filters.filter( @@ -59,20 +60,23 @@ export function buildEsQuery( const kueryQuery = buildQueryFromKuery( indexPattern, queriesByLanguage.kuery, - config.allowLeadingWildcards, - config.dateFormatTZ, - config.filtersInMustClause + { allowLeadingWildcards: config.allowLeadingWildcards }, + { + dateFormatTZ: config.dateFormatTZ, + filtersInMustClause: config.filtersInMustClause, + nestedIgnoreUnmapped: config.nestedIgnoreUnmapped, + } ); const luceneQuery = buildQueryFromLucene( queriesByLanguage.lucene, config.queryStringOptions, config.dateFormatTZ ); - const filterQuery = buildQueryFromFilters( - filters, - indexPattern, - config.ignoreFilterIfFieldNotInIndex - ); + + const filterQuery = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: config.ignoreFilterIfFieldNotInIndex, + nestedIgnoreUnmapped: config.nestedIgnoreUnmapped, + }); return { bool: { diff --git a/packages/kbn-es-query/src/es_query/from_filters.test.ts b/packages/kbn-es-query/src/es_query/from_filters.test.ts index 67de9e4d88736..78b719ccc0e62 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.test.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.test.ts @@ -19,7 +19,9 @@ describe('build query', () => { describe('buildQueryFromFilters', () => { test('should return the parameters of an Elasticsearch bool query', () => { - const result = buildQueryFromFilters([], indexPattern, false); + const result = buildQueryFromFilters([], indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); const expected = { must: [], filter: [], @@ -43,7 +45,9 @@ describe('build query', () => { const expectedESQueries = [{ match_all: {} }, { exists: { field: 'foo' } }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -55,14 +59,18 @@ describe('build query', () => { meta: { type: 'match_all', negate: true, disabled: true }, } as MatchAllFilter, ] as Filter[]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual([]); }); test('should remove falsy filters', () => { const filters = [null, undefined] as unknown as Filter[]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual([]); expect(result.must).toEqual([]); @@ -78,7 +86,9 @@ describe('build query', () => { const expectedESQueries = [{ match_all: {} }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.must_not).toEqual(expectedESQueries); }); @@ -97,7 +107,9 @@ describe('build query', () => { }, ]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -116,7 +128,9 @@ describe('build query', () => { }, ]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -130,7 +144,9 @@ describe('build query', () => { ] as Filter[]; const expectedESQueries = [{ query_string: { query: 'foo' } }]; - const result = buildQueryFromFilters(filters, indexPattern, false); + const result = buildQueryFromFilters(filters, indexPattern, { + ignoreFilterIfFieldNotInIndex: false, + }); expect(result.filter).toEqual(expectedESQueries); }); @@ -159,5 +175,31 @@ describe('build query', () => { const result = buildQueryFromFilters(filters, indexPattern); expect(result.filter).toEqual(expectedESQueries); }); + + test('should allow to configure ignore_unmapped for filters targeting nested fields in a nested query', () => { + const filters = [ + { + query: { exists: { field: 'nestedField.child' } }, + meta: { type: 'exists', alias: '', disabled: false, negate: false }, + }, + ]; + + const expectedESQueries = [ + { + nested: { + path: 'nestedField', + query: { + exists: { + field: 'nestedField.child', + }, + }, + ignore_unmapped: true, + }, + }, + ]; + + const result = buildQueryFromFilters(filters, indexPattern, { nestedIgnoreUnmapped: true }); + expect(result.filter).toEqual(expectedESQueries); + }); }); }); diff --git a/packages/kbn-es-query/src/es_query/from_filters.ts b/packages/kbn-es-query/src/es_query/from_filters.ts index e018cdc3404ad..871ff77026b54 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.ts @@ -38,6 +38,23 @@ const translateToQuery = (filter: Partial): estypes.QueryDslQueryContain return filter.query || filter; }; +/** + * Options for building query for filters + */ +export interface EsQueryFiltersConfig { + /** + * by default filters that use fields that can't be found in the specified index pattern are not applied. Set this to true if you want to apply them anyway. + */ + ignoreFilterIfFieldNotInIndex?: boolean; + + /** + * the nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error. + * The optional ignore_unmapped parameter defaults to false. + * This `nestedIgnoreUnmapped` param allows creating queries with "ignore_unmapped": true + */ + nestedIgnoreUnmapped?: boolean; +} + /** * @param filters * @param indexPattern @@ -49,7 +66,9 @@ const translateToQuery = (filter: Partial): estypes.QueryDslQueryContain export const buildQueryFromFilters = ( filters: Filter[] = [], indexPattern: DataViewBase | undefined, - ignoreFilterIfFieldNotInIndex: boolean = false + { ignoreFilterIfFieldNotInIndex = false, nestedIgnoreUnmapped }: EsQueryFiltersConfig = { + ignoreFilterIfFieldNotInIndex: false, + } ): BoolQuery => { filters = filters.filter((filter) => filter && !isFilterDisabled(filter)); @@ -63,7 +82,9 @@ export const buildQueryFromFilters = ( .map((filter) => { return migrateFilter(filter, indexPattern); }) - .map((filter) => handleNestedFilter(filter, indexPattern)) + .map((filter) => + handleNestedFilter(filter, indexPattern, { ignoreUnmapped: nestedIgnoreUnmapped }) + ) .map(cleanFilter) .map(translateToQuery); }; diff --git a/packages/kbn-es-query/src/es_query/from_kuery.test.ts b/packages/kbn-es-query/src/es_query/from_kuery.test.ts index 443b44dff5819..60bdb54858240 100644 --- a/packages/kbn-es-query/src/es_query/from_kuery.test.ts +++ b/packages/kbn-es-query/src/es_query/from_kuery.test.ts @@ -22,7 +22,7 @@ describe('build query', () => { describe('buildQueryFromKuery', () => { test('should return the parameters of an Elasticsearch bool query', () => { - const result = buildQueryFromKuery(undefined, [], true); + const result = buildQueryFromKuery(undefined, [], { allowLeadingWildcards: true }); const expected = { must: [], filter: [], @@ -42,7 +42,7 @@ describe('build query', () => { return toElasticsearchQuery(fromKueryExpression(query.query), indexPattern); }); - const result = buildQueryFromKuery(indexPattern, queries, true); + const result = buildQueryFromKuery(indexPattern, queries, { allowLeadingWildcards: true }); expect(result.filter).toEqual(expectedESQueries); }); @@ -55,7 +55,14 @@ describe('build query', () => { }); }); - const result = buildQueryFromKuery(indexPattern, queries, true, 'America/Phoenix'); + const result = buildQueryFromKuery( + indexPattern, + queries, + { allowLeadingWildcards: true }, + { + dateFormatTZ: 'America/Phoenix', + } + ); expect(result.filter).toEqual(expectedESQueries); }); @@ -68,7 +75,7 @@ describe('build query', () => { return toElasticsearchQuery(fromKueryExpression(query.query), indexPattern); }); - const result = buildQueryFromKuery(indexPattern, queries, true); + const result = buildQueryFromKuery(indexPattern, queries, { allowLeadingWildcards: true }); expect(result.filter).toEqual(expectedESQueries); }); diff --git a/packages/kbn-es-query/src/es_query/from_kuery.ts b/packages/kbn-es-query/src/es_query/from_kuery.ts index 3bb5d45fc53e3..6a1254a6e5037 100644 --- a/packages/kbn-es-query/src/es_query/from_kuery.ts +++ b/packages/kbn-es-query/src/es_query/from_kuery.ts @@ -6,30 +6,42 @@ * Side Public License, v 1. */ -import { SerializableRecord } from '@kbn/utility-types'; import { Query } from '../filters'; -import { fromKueryExpression, toElasticsearchQuery, nodeTypes, KueryNode } from '../kuery'; +import { + fromKueryExpression, + toElasticsearchQuery, + nodeTypes, + KueryNode, + KueryQueryOptions, +} from '../kuery'; import { BoolQuery, DataViewBase } from './types'; /** @internal */ export function buildQueryFromKuery( indexPattern: DataViewBase | undefined, queries: Query[] = [], - allowLeadingWildcards: boolean = false, - dateFormatTZ?: string, - filtersInMustClause: boolean = false + { allowLeadingWildcards = false }: { allowLeadingWildcards?: boolean } = { + allowLeadingWildcards: false, + }, + { filtersInMustClause = false, dateFormatTZ, nestedIgnoreUnmapped }: KueryQueryOptions = { + filtersInMustClause: false, + } ): BoolQuery { const queryASTs = queries.map((query) => { return fromKueryExpression(query.query, { allowLeadingWildcards }); }); - return buildQuery(indexPattern, queryASTs, { dateFormatTZ, filtersInMustClause }); + return buildQuery(indexPattern, queryASTs, { + filtersInMustClause, + dateFormatTZ, + nestedIgnoreUnmapped, + }); } function buildQuery( indexPattern: DataViewBase | undefined, queryASTs: KueryNode[], - config: SerializableRecord = {} + config: KueryQueryOptions = {} ): BoolQuery { const compoundQueryAST = nodeTypes.function.buildNode('and', queryASTs); const kueryQuery = toElasticsearchQuery(compoundQueryAST, indexPattern, config); diff --git a/packages/kbn-es-query/src/es_query/from_lucene.ts b/packages/kbn-es-query/src/es_query/from_lucene.ts index d00614b31347f..9f72f3bf0ef6e 100644 --- a/packages/kbn-es-query/src/es_query/from_lucene.ts +++ b/packages/kbn-es-query/src/es_query/from_lucene.ts @@ -15,7 +15,7 @@ import { BoolQuery } from './types'; /** @internal */ export function buildQueryFromLucene( queries: Query[], - queryStringOptions: SerializableRecord, + queryStringOptions: SerializableRecord = {}, dateFormatTZ?: string ): BoolQuery { const combinedQueries = (queries || []).map((query) => { diff --git a/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts b/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts index 2b9fbbe5ece04..01ce78dfbab9f 100644 --- a/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts +++ b/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts @@ -39,6 +39,28 @@ describe('handleNestedFilter', function () { }); }); + it('should allow to configure ignore_unmapped', () => { + const field = getField('nestedField.child'); + const filter = buildPhraseFilter(field!, 'foo', indexPattern); + const result = handleNestedFilter(filter, indexPattern, { ignoreUnmapped: true }); + expect(result).toEqual({ + meta: { + index: 'logstash-*', + }, + query: { + nested: { + path: 'nestedField', + query: { + match_phrase: { + 'nestedField.child': 'foo', + }, + }, + ignore_unmapped: true, + }, + }, + }); + }); + it('should return filter untouched if it does not target a nested field', () => { const field = getField('extension'); const filter = buildPhraseFilter(field!, 'jpg', indexPattern); diff --git a/packages/kbn-es-query/src/es_query/handle_nested_filter.ts b/packages/kbn-es-query/src/es_query/handle_nested_filter.ts index 14138ca44d310..fb32d55e53a7e 100644 --- a/packages/kbn-es-query/src/es_query/handle_nested_filter.ts +++ b/packages/kbn-es-query/src/es_query/handle_nested_filter.ts @@ -11,7 +11,11 @@ import { DataViewBase } from './types'; import { getDataViewFieldSubtypeNested } from '../utils'; /** @internal */ -export const handleNestedFilter = (filter: Filter, indexPattern?: DataViewBase) => { +export const handleNestedFilter = ( + filter: Filter, + indexPattern?: DataViewBase, + config: { ignoreUnmapped?: boolean } = {} +) => { if (!indexPattern) return filter; const fieldName = getFilterField(filter); @@ -36,6 +40,9 @@ export const handleNestedFilter = (filter: Filter, indexPattern?: DataViewBase) nested: { path: subTypeNested.nested.path, query: query.query || query, + ...(typeof config.ignoreUnmapped === 'boolean' && { + ignore_unmapped: config.ignoreUnmapped, + }), }, }, }; diff --git a/packages/kbn-es-query/src/es_query/index.ts b/packages/kbn-es-query/src/es_query/index.ts index 399df50e35058..d4e45b35728f6 100644 --- a/packages/kbn-es-query/src/es_query/index.ts +++ b/packages/kbn-es-query/src/es_query/index.ts @@ -7,6 +7,7 @@ */ export { migrateFilter } from './migrate_filter'; +export type { EsQueryFiltersConfig } from './from_filters'; export type { EsQueryConfig } from './build_es_query'; export { buildEsQuery } from './build_es_query'; export { buildQueryFromFilters } from './from_filters'; diff --git a/packages/kbn-es-query/src/index.ts b/packages/kbn-es-query/src/index.ts index 5b0b0a4f1d3a9..aadec300b5610 100644 --- a/packages/kbn-es-query/src/index.ts +++ b/packages/kbn-es-query/src/index.ts @@ -11,6 +11,7 @@ export type { DataViewBase, DataViewFieldBase, EsQueryConfig, + EsQueryFiltersConfig, IFieldSubType, IFieldSubTypeMulti, IFieldSubTypeNested, diff --git a/packages/kbn-es-query/src/kuery/functions/is.test.ts b/packages/kbn-es-query/src/kuery/functions/is.test.ts index 2ec53629b9dca..1a8229a62fe2a 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.test.ts @@ -314,6 +314,32 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); + + test('should allow to configure ignore_unmapped for a nested query', () => { + const expected = { + bool: { + should: [ + { + nested: { + path: 'nestedField.nestedChild', + query: { + match: { + 'nestedField.nestedChild.doublyNestedChild': 'foo', + }, + }, + score_mode: 'none', + ignore_unmapped: true, + }, + }, + ], + minimum_should_match: 1, + }, + }; + const node = nodeTypes.function.buildNode('is', '*doublyNested*', 'foo'); + const result = is.toElasticsearchQuery(node, indexPattern, { nestedIgnoreUnmapped: true }); + + expect(result).toEqual(expected); + }); }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/is.ts b/packages/kbn-es-query/src/kuery/functions/is.ts index eeb9f139c9e52..fcf7dffabef86 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.ts @@ -114,6 +114,9 @@ export function toElasticsearchQuery( path: subTypeNested.nested.path, query, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/functions/nested.ts b/packages/kbn-es-query/src/kuery/functions/nested.ts index 18cd9794922c6..ea3ee1b4fc131 100644 --- a/packages/kbn-es-query/src/kuery/functions/nested.ts +++ b/packages/kbn-es-query/src/kuery/functions/nested.ts @@ -37,6 +37,9 @@ export function toElasticsearchQuery( nested: { path: fullPath }, }) as estypes.QueryDslQueryContainer, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/functions/range.test.ts b/packages/kbn-es-query/src/kuery/functions/range.test.ts index 575246724d6b2..9ff2fc54563b4 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.test.ts @@ -229,6 +229,36 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); + + test('should allow to configure ignore_unmapped for a nested query', () => { + const expected = { + bool: { + should: [ + { + nested: { + path: 'nestedField.nestedChild', + query: { + range: { + 'nestedField.nestedChild.doublyNestedChild': { + lt: 8000, + }, + }, + }, + score_mode: 'none', + ignore_unmapped: true, + }, + }, + ], + minimum_should_match: 1, + }, + }; + const node = nodeTypes.function.buildNode('range', '*doublyNested*', 'lt', 8000); + const result = range.toElasticsearchQuery(node, indexPattern, { + nestedIgnoreUnmapped: true, + }); + + expect(result).toEqual(expected); + }); }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/range.ts b/packages/kbn-es-query/src/kuery/functions/range.ts index 313f6571259a0..c355f02027e8e 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.ts @@ -66,6 +66,9 @@ export function toElasticsearchQuery( path: subTypeNested.nested.path, query, score_mode: 'none', + ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { + ignore_unmapped: config.nestedIgnoreUnmapped, + }), }, }; } diff --git a/packages/kbn-es-query/src/kuery/types.ts b/packages/kbn-es-query/src/kuery/types.ts index 7b35eb10ff7b8..7a6e7a9c6bf63 100644 --- a/packages/kbn-es-query/src/kuery/types.ts +++ b/packages/kbn-es-query/src/kuery/types.ts @@ -39,4 +39,11 @@ export { nodeTypes } from './node_types'; export interface KueryQueryOptions { filtersInMustClause?: boolean; dateFormatTZ?: string; + + /** + * the Nested field type requires a special query syntax, which includes an optional ignore_unmapped parameter that indicates whether to ignore an unmapped path and not return any documents instead of an error. + * The optional ignore_unmapped parameter defaults to false. + * The `nestedIgnoreUnmapped` param allows creating queries with "ignore_unmapped": true + */ + nestedIgnoreUnmapped?: boolean; } diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index 329bd18e33952..3df97ff607ad8 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -1806,6 +1806,29 @@ class CiStatsReporter { await flushBuffer(); } } + + async reportPerformanceMetrics(metrics) { + var _this$config9; + + if (!this.hasBuildConfig()) { + return; + } + + const buildId = (_this$config9 = this.config) === null || _this$config9 === void 0 ? void 0 : _this$config9.buildId; + + if (!buildId) { + throw new Error(`Performance metrics can't be reported without a buildId`); + } + + return !!(await this.req({ + auth: true, + path: `/v1/performance_metrics_report?buildId=${buildId}`, + body: { + metrics + }, + bodyDesc: `performance metrics: ${metrics}` + })); + } /** * In order to allow this code to run before @kbn/utils is built, @kbn/pm will pass * in the upstreamBranch when calling the timings() method. Outside of @kbn/pm @@ -61948,12 +61971,14 @@ const BootstrapCommand = { ms: Date.now() - start }); } - }; // Force install is set in case a flag is passed into yarn kbn bootstrap + }; // Force install is set in case a flag is passed into yarn kbn bootstrap or + // our custom logic have determined there is a chance node_modules have been manually deleted and as such bazel + // tracking mechanism is no longer valid - const forceInstall = !!options && options['force-install'] === true; // Install bazel machinery tools if needed + const forceInstall = !!options && options['force-install'] === true || (await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_8__[/* haveNodeModulesBeenManuallyDeleted */ "c"])(kibanaProjectPath)); // Install bazel machinery tools if needed - await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_8__[/* installBazelTools */ "c"])(rootPath); // Setup remote cache settings in .bazelrc.cache if needed + await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_8__[/* installBazelTools */ "d"])(rootPath); // Setup remote cache settings in .bazelrc.cache if needed await Object(_utils_bazel_setup_remote_cache__WEBPACK_IMPORTED_MODULE_9__[/* setupRemoteCache */ "a"])(rootPath); // Bootstrap process for Bazel packages // Bazel is now managing dependencies so yarn install @@ -61967,7 +61992,7 @@ const BootstrapCommand = { if (forceInstall) { await time('force install dependencies', async () => { - await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_8__[/* removeYarnIntegrityFileIfExists */ "e"])(path__WEBPACK_IMPORTED_MODULE_0___default.a.resolve(kibanaProjectPath, 'node_modules')); + await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_8__[/* removeYarnIntegrityFileIfExists */ "f"])(path__WEBPACK_IMPORTED_MODULE_0___default.a.resolve(kibanaProjectPath, 'node_modules')); await Object(_kbn_bazel_runner__WEBPACK_IMPORTED_MODULE_2__["runBazel"])({ bazelArgs: ['clean', '--expunge'], log: _utils_log__WEBPACK_IMPORTED_MODULE_3__[/* log */ "a"] @@ -62148,7 +62173,7 @@ const CleanCommand = { } // Runs Bazel soft clean - if (await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_5__[/* isBazelBinAvailable */ "d"])(kbn.getAbsolute())) { + if (await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_5__[/* isBazelBinAvailable */ "e"])(kbn.getAbsolute())) { await Object(_kbn_bazel_runner__WEBPACK_IMPORTED_MODULE_4__["runBazel"])({ bazelArgs: ['clean'], log: _utils_log__WEBPACK_IMPORTED_MODULE_7__[/* log */ "a"] @@ -62308,7 +62333,7 @@ const ResetCommand = { } // Runs Bazel hard clean and deletes Bazel Cache Folders - if (await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_5__[/* isBazelBinAvailable */ "d"])(kbn.getAbsolute())) { + if (await Object(_utils_bazel__WEBPACK_IMPORTED_MODULE_5__[/* isBazelBinAvailable */ "e"])(kbn.getAbsolute())) { // Hard cleaning bazel await Object(_kbn_bazel_runner__WEBPACK_IMPORTED_MODULE_4__["runBazel"])({ bazelArgs: ['clean', '--expunge'], @@ -62776,12 +62801,14 @@ async function getBazelRepositoryCacheFolder() { /* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "b", function() { return _get_cache_folders__WEBPACK_IMPORTED_MODULE_0__["b"]; }); /* harmony import */ var _install_tools__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("./src/utils/bazel/install_tools.ts"); -/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "c", function() { return _install_tools__WEBPACK_IMPORTED_MODULE_1__["a"]; }); +/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "d", function() { return _install_tools__WEBPACK_IMPORTED_MODULE_1__["a"]; }); + +/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "e", function() { return _install_tools__WEBPACK_IMPORTED_MODULE_1__["b"]; }); -/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "d", function() { return _install_tools__WEBPACK_IMPORTED_MODULE_1__["b"]; }); +/* harmony import */ var _yarn__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__("./src/utils/bazel/yarn.ts"); +/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "c", function() { return _yarn__WEBPACK_IMPORTED_MODULE_2__["a"]; }); -/* harmony import */ var _yarn_integrity__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__("./src/utils/bazel/yarn_integrity.ts"); -/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "e", function() { return _yarn_integrity__WEBPACK_IMPORTED_MODULE_2__["a"]; }); +/* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "f", function() { return _yarn__WEBPACK_IMPORTED_MODULE_2__["b"]; }); /* * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one @@ -62984,11 +63011,12 @@ async function setupRemoteCache(repoRootPath) { /***/ }), -/***/ "./src/utils/bazel/yarn_integrity.ts": +/***/ "./src/utils/bazel/yarn.ts": /***/ (function(module, __webpack_exports__, __webpack_require__) { "use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return removeYarnIntegrityFileIfExists; }); +/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "b", function() { return removeYarnIntegrityFileIfExists; }); +/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return haveNodeModulesBeenManuallyDeleted; }); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("path"); /* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_0__); /* harmony import */ var _fs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("./src/utils/fs.ts"); @@ -63000,6 +63028,7 @@ async function setupRemoteCache(repoRootPath) { * Side Public License, v 1. */ + // yarn integrity file checker async function removeYarnIntegrityFileIfExists(nodeModulesPath) { try { @@ -63011,6 +63040,26 @@ async function removeYarnIntegrityFileIfExists(nodeModulesPath) { } } catch {// no-op } +} // yarn and bazel integration checkers + +async function areNodeModulesPresent(kbnRootPath) { + try { + return await Object(_fs__WEBPACK_IMPORTED_MODULE_1__[/* isDirectory */ "c"])(Object(path__WEBPACK_IMPORTED_MODULE_0__["resolve"])(kbnRootPath, 'node_modules')); + } catch { + return false; + } +} + +async function haveBazelFoldersBeenCreatedBefore(kbnRootPath) { + try { + return (await Object(_fs__WEBPACK_IMPORTED_MODULE_1__[/* isDirectory */ "c"])(Object(path__WEBPACK_IMPORTED_MODULE_0__["resolve"])(kbnRootPath, 'bazel-bin', 'packages'))) || (await Object(_fs__WEBPACK_IMPORTED_MODULE_1__[/* isDirectory */ "c"])(Object(path__WEBPACK_IMPORTED_MODULE_0__["resolve"])(kbnRootPath, 'bazel-kibana', 'packages'))) || (await Object(_fs__WEBPACK_IMPORTED_MODULE_1__[/* isDirectory */ "c"])(Object(path__WEBPACK_IMPORTED_MODULE_0__["resolve"])(kbnRootPath, 'bazel-out', 'host'))); + } catch { + return false; + } +} + +async function haveNodeModulesBeenManuallyDeleted(kbnRootPath) { + return !(await areNodeModulesPresent(kbnRootPath)) && (await haveBazelFoldersBeenCreatedBefore(kbnRootPath)); } /***/ }), diff --git a/packages/kbn-pm/src/commands/bootstrap.ts b/packages/kbn-pm/src/commands/bootstrap.ts index 3f9275cff8e61..8ac55b3478363 100644 --- a/packages/kbn-pm/src/commands/bootstrap.ts +++ b/packages/kbn-pm/src/commands/bootstrap.ts @@ -16,7 +16,11 @@ import { linkProjectExecutables } from '../utils/link_project_executables'; import { ICommand } from '.'; import { readYarnLock } from '../utils/yarn_lock'; import { validateDependencies } from '../utils/validate_dependencies'; -import { installBazelTools, removeYarnIntegrityFileIfExists } from '../utils/bazel'; +import { + installBazelTools, + haveNodeModulesBeenManuallyDeleted, + removeYarnIntegrityFileIfExists, +} from '../utils/bazel'; import { setupRemoteCache } from '../utils/bazel/setup_remote_cache'; export const BootstrapCommand: ICommand = { @@ -46,8 +50,12 @@ export const BootstrapCommand: ICommand = { } }; - // Force install is set in case a flag is passed into yarn kbn bootstrap - const forceInstall = !!options && options['force-install'] === true; + // Force install is set in case a flag is passed into yarn kbn bootstrap or + // our custom logic have determined there is a chance node_modules have been manually deleted and as such bazel + // tracking mechanism is no longer valid + const forceInstall = + (!!options && options['force-install'] === true) || + (await haveNodeModulesBeenManuallyDeleted(kibanaProjectPath)); // Install bazel machinery tools if needed await installBazelTools(rootPath); diff --git a/packages/kbn-pm/src/utils/bazel/index.ts b/packages/kbn-pm/src/utils/bazel/index.ts index 39b3cb9c61f00..d1460d5598f55 100644 --- a/packages/kbn-pm/src/utils/bazel/index.ts +++ b/packages/kbn-pm/src/utils/bazel/index.ts @@ -8,4 +8,4 @@ export * from './get_cache_folders'; export * from './install_tools'; -export * from './yarn_integrity'; +export * from './yarn'; diff --git a/packages/kbn-pm/src/utils/bazel/yarn.ts b/packages/kbn-pm/src/utils/bazel/yarn.ts new file mode 100644 index 0000000000000..24e44be3b3cdf --- /dev/null +++ b/packages/kbn-pm/src/utils/bazel/yarn.ts @@ -0,0 +1,53 @@ +/* + * 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. + */ + +import { join, resolve } from 'path'; +import { isDirectory, isFile, tryRealpath, unlink } from '../fs'; + +// yarn integrity file checker +export async function removeYarnIntegrityFileIfExists(nodeModulesPath: string) { + try { + const nodeModulesRealPath = await tryRealpath(nodeModulesPath); + const yarnIntegrityFilePath = join(nodeModulesRealPath, '.yarn-integrity'); + + // check if the file exists and delete it in that case + if (await isFile(yarnIntegrityFilePath)) { + await unlink(yarnIntegrityFilePath); + } + } catch { + // no-op + } +} + +// yarn and bazel integration checkers +async function areNodeModulesPresent(kbnRootPath: string) { + try { + return await isDirectory(resolve(kbnRootPath, 'node_modules')); + } catch { + return false; + } +} + +async function haveBazelFoldersBeenCreatedBefore(kbnRootPath: string) { + try { + return ( + (await isDirectory(resolve(kbnRootPath, 'bazel-bin', 'packages'))) || + (await isDirectory(resolve(kbnRootPath, 'bazel-kibana', 'packages'))) || + (await isDirectory(resolve(kbnRootPath, 'bazel-out', 'host'))) + ); + } catch { + return false; + } +} + +export async function haveNodeModulesBeenManuallyDeleted(kbnRootPath: string) { + return ( + !(await areNodeModulesPresent(kbnRootPath)) && + (await haveBazelFoldersBeenCreatedBefore(kbnRootPath)) + ); +} diff --git a/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts b/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts deleted file mode 100644 index 1ac9bfeba1e3b..0000000000000 --- a/packages/kbn-pm/src/utils/bazel/yarn_integrity.ts +++ /dev/null @@ -1,24 +0,0 @@ -/* - * 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. - */ - -import { join } from 'path'; -import { isFile, tryRealpath, unlink } from '../fs'; - -export async function removeYarnIntegrityFileIfExists(nodeModulesPath: string) { - try { - const nodeModulesRealPath = await tryRealpath(nodeModulesPath); - const yarnIntegrityFilePath = join(nodeModulesRealPath, '.yarn-integrity'); - - // check if the file exists and delete it in that case - if (await isFile(yarnIntegrityFilePath)) { - await unlink(yarnIntegrityFilePath); - } - } catch { - // no-op - } -} diff --git a/packages/kbn-shared-ux-components/BUILD.bazel b/packages/kbn-shared-ux-components/BUILD.bazel index 1a4a7100ded72..20d71557fef9a 100644 --- a/packages/kbn-shared-ux-components/BUILD.bazel +++ b/packages/kbn-shared-ux-components/BUILD.bazel @@ -45,6 +45,7 @@ RUNTIME_DEPS = [ "//packages/shared-ux/avatar/solution", "//packages/shared-ux/link/redirect_app", "//packages/shared-ux/prompt/no_data_views", + "//packages/shared-ux/card/no_data", "//packages/kbn-shared-ux-services", "//packages/kbn-shared-ux-storybook", "//packages/kbn-shared-ux-utility", @@ -74,6 +75,7 @@ TYPES_DEPS = [ "//packages/shared-ux/avatar/solution:npm_module_types", "//packages/shared-ux/link/redirect_app:npm_module_types", "//packages/shared-ux/prompt/no_data_views:npm_module_types", + "//packages/shared-ux/card/no_data:npm_module_types", "//packages/kbn-shared-ux-services:npm_module_types", "//packages/kbn-shared-ux-storybook:npm_module_types", "//packages/kbn-shared-ux-utility:npm_module_types", diff --git a/packages/kbn-shared-ux-components/src/page_template/__snapshots__/page_template.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/__snapshots__/page_template.test.tsx.snap index e41292f549c99..e535354b3f084 100644 --- a/packages/kbn-shared-ux-components/src/page_template/__snapshots__/page_template.test.tsx.snap +++ b/packages/kbn-shared-ux-components/src/page_template/__snapshots__/page_template.test.tsx.snap @@ -22,7 +22,7 @@ exports[`KibanaPageTemplate render basic template 1`] = ` class="euiFlexItem" >

test @@ -46,7 +46,7 @@ exports[`KibanaPageTemplate render basic template 1`] = `

- - - -

- Welcome to Elastic Analytics! -

- -

- - - , - "solution": "Analytics", - } - } - /> -

- - - - -
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts index 894097727cd1f..a6f8c91f7614c 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -export { NoDataCard, ElasticAgentCard } from './no_data_card'; export { NoDataPage } from './no_data_page'; export type { NoDataPageProps } from './types'; export { NoDataConfigPage, NoDataConfigPageWithSolutionNavBar } from './no_data_config_page'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap deleted file mode 100644 index c871196b92282..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.component.test.tsx.snap +++ /dev/null @@ -1,104 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`ElasticAgentCardComponent props button 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent props href 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent renders 1`] = ` - - } - title="Add Elastic Agent" -/> -`; - -exports[`ElasticAgentCardComponent renders with canAccessFleet false 1`] = ` - - This integration is not yet enabled. Your administrator has the required permissions to turn it on. - - } - image={ - - } - isDisabled={true} - title={ - - Contact your administrator - - } -/> -`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap deleted file mode 100644 index dbdb652a10c1f..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/elastic_agent_card.test.tsx.snap +++ /dev/null @@ -1,75 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`ElasticAgentCard renders 1`] = ` -
-
-
-
-
- -
-
-
-
- - - - Add Elastic Agent - - - -
-

- Use Elastic Agent for a simple, unified way to collect data from your machines. -

-
-
-
- -
-
-
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap deleted file mode 100644 index 0028d505e9187..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/__snapshots__/no_data_card.test.tsx.snap +++ /dev/null @@ -1,231 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`NoDataCard props button 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props extends EuiCardProps 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props href 1`] = ` -
-
- - - - Card title - - - -
-

- Description -

-
-
-
- -
-
-`; - -exports[`NoDataCard props isDisabled 1`] = ` -
-
- - - -
-

- Description -

-
-
-
-`; - -exports[`NoDataCard renders 1`] = ` -
-
- - - Card title - - -
-

- Description -

-
-
-
- -
-
-`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx deleted file mode 100644 index 367fcd10b96a9..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.test.tsx +++ /dev/null @@ -1,43 +0,0 @@ -/* - * 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. - */ - -import { shallow } from 'enzyme'; -import React from 'react'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; -import { NoDataCard } from './no_data_card'; - -describe('ElasticAgentCardComponent', () => { - test('renders', () => { - const component = shallow(); - expect(component).toMatchSnapshot(); - }); - - test('renders with canAccessFleet false', () => { - const component = shallow(); - expect(component.find(NoDataCard).props().isDisabled).toBe(true); - expect(component).toMatchSnapshot(); - }); - - describe('props', () => { - test('button', () => { - const component = shallow( - - ); - expect(component.find(NoDataCard).props().button).toBe('Button'); - expect(component).toMatchSnapshot(); - }); - - test('href', () => { - const component = shallow( - - ); - expect(component.find(NoDataCard).props().href).toBe('some path'); - expect(component).toMatchSnapshot(); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx deleted file mode 100644 index 31d0aad7cc631..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.component.tsx +++ /dev/null @@ -1,83 +0,0 @@ -/* - * 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. - */ - -import React, { FunctionComponent } from 'react'; -import { i18n } from '@kbn/i18n'; -import { EuiImage, EuiTextColor } from '@elastic/eui'; -import { ElasticAgentCardProps } from './types'; -import { NoDataCard } from './no_data_card'; -import ElasticAgentCardIllustration from './assets/elastic_agent_card.svg'; - -export type ElasticAgentCardComponentProps = ElasticAgentCardProps & { - canAccessFleet: boolean; -}; - -const noPermissionTitle = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title', - { - defaultMessage: `Contact your administrator`, - } -); - -const noPermissionDescription = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description', - { - defaultMessage: `This integration is not yet enabled. Your administrator has the required permissions to turn it on.`, - } -); - -const elasticAgentCardTitle = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.title', - { - defaultMessage: 'Add Elastic Agent', - } -); - -const elasticAgentCardDescription = i18n.translate( - 'sharedUXComponents.noDataPage.elasticAgentCard.description', - { - defaultMessage: `Use Elastic Agent for a simple, unified way to collect data from your machines.`, - } -); - -/** - * Creates a specific NoDataCard pointing users to Integrations when `canAccessFleet` - */ -export const ElasticAgentCardComponent: FunctionComponent = ({ - canAccessFleet, - title = elasticAgentCardTitle, - description, - ...cardRest -}) => { - const props = canAccessFleet - ? { - title, - description: description || elasticAgentCardDescription, - } - : { - title: {noPermissionTitle}, - description: {noPermissionDescription}, - isDisabled: true, - }; - - const image = ( - - ); - - return ; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx deleted file mode 100644 index a87da6ff9ca0e..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.stories.tsx +++ /dev/null @@ -1,42 +0,0 @@ -/* - * 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. - */ - -import React from 'react'; - -import { - ElasticAgentCardComponent as Component, - ElasticAgentCardComponentProps as ComponentProps, -} from './elastic_agent_card.component'; - -import { ElasticAgentCard } from './elastic_agent_card'; - -export default { - title: 'Page Template/No Data/Elastic Agent Data Card', - description: 'A solution-specific wrapper around NoDataCard, to be used on NoData page', -}; - -type Params = Pick; - -export const PureComponent = (params: Params) => { - return ; -}; - -PureComponent.argTypes = { - canAccessFleet: { - control: 'boolean', - defaultValue: true, - }, - description: { - control: 'text', - defaultValue: '', - }, -}; - -export const ConnectedComponent = () => { - return ; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx deleted file mode 100644 index ed0b4471fa32c..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.test.tsx +++ /dev/null @@ -1,78 +0,0 @@ -/* - * 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. - */ - -import { ReactWrapper } from 'enzyme'; -import React from 'react'; -import { mountWithIntl } from '@kbn/test-jest-helpers'; -import { - SharedUxServicesProvider, - SharedUxServices, - mockServicesFactory, -} from '@kbn/shared-ux-services'; - -import { ElasticAgentCard } from './elastic_agent_card'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; - -describe('ElasticAgentCard', () => { - let services: SharedUxServices; - let mount: (element: JSX.Element) => ReactWrapper; - - beforeEach(() => { - services = mockServicesFactory(); - mount = (element: JSX.Element) => - mountWithIntl({element}); - }); - - afterEach(() => { - jest.resetAllMocks(); - }); - - test('renders', () => { - const component = mount(); - expect(component.render()).toMatchSnapshot(); - }); - - describe('href', () => { - test('returns href if href is given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe('/take/me/somewhere'); - }); - - test('returns prefix + category if href is not given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe( - '/app/integrations/browse/solutions' - ); - }); - - test('returns prefix if nor category nor href are given', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().href).toBe( - '/app/integrations/browse' - ); - }); - }); - - describe('description', () => { - test('renders custom description if provided', () => { - const component = mount( - - ); - expect(component.find(ElasticAgentCardComponent).props().description).toBe( - 'Build seamless search experiences faster.' - ); - }); - }); - - describe('canAccessFleet', () => { - test('passes in the right parameter', () => { - const component = mount(); - expect(component.find(ElasticAgentCardComponent).props().canAccessFleet).toBe(true); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx deleted file mode 100644 index a4025f33616ed..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/elastic_agent_card.tsx +++ /dev/null @@ -1,45 +0,0 @@ -/* - * 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. - */ - -import React, { useMemo } from 'react'; -import { useApplication, useHttp, usePermissions } from '@kbn/shared-ux-services'; -import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app'; -import useObservable from 'react-use/lib/useObservable'; - -import { ElasticAgentCardProps } from './types'; -import { ElasticAgentCardComponent } from './elastic_agent_card.component'; - -export const ElasticAgentCard = (props: ElasticAgentCardProps) => { - const { canAccessFleet } = usePermissions(); - const { addBasePath } = useHttp(); - const { navigateToUrl, currentAppId$ } = useApplication(); - const currentAppId = useObservable(currentAppId$); - - const { href: srcHref, category, description } = props; - - const href = useMemo(() => { - if (srcHref) { - return srcHref; - } - - // TODO: get this URL from a locator - const prefix = '/app/integrations/browse'; - - if (category) { - return addBasePath(`${prefix}/${category}`); - } - - return addBasePath(prefix); - }, [addBasePath, srcHref, category]); - - return ( - - - - ); -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts deleted file mode 100644 index e4cdeb401584f..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * 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 { NoDataCard } from './no_data_card'; -export { ElasticAgentCard } from './elastic_agent_card'; -export type { NoDataCardProps, ElasticAgentCardProps } from './types'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx deleted file mode 100644 index 9c1b2d0322074..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.stories.tsx +++ /dev/null @@ -1,37 +0,0 @@ -/* - * 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. - */ - -import React from 'react'; -import { NoDataCard } from './no_data_card'; -import type { NoDataCardProps } from './types'; - -export default { - title: 'Page Template/No Data/No Data Card', - description: 'A wrapper around EuiCard, to be used on NoData page', -}; - -type Params = Pick; - -export const PureComponent = (params: Params) => { - return ; -}; - -PureComponent.argTypes = { - button: { - control: { - type: 'text', - }, - defaultValue: 'Button text', - }, - description: { - control: { - type: 'text', - }, - defaultValue: 'This is a description', - }, -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx deleted file mode 100644 index 6bbed463f23ed..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.test.tsx +++ /dev/null @@ -1,58 +0,0 @@ -/* - * 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. - */ - -import { render } from 'enzyme'; -import React from 'react'; -import { NoDataCard } from './no_data_card'; - -describe('NoDataCard', () => { - test('renders', () => { - const component = render(); - expect(component).toMatchSnapshot(); - }); - - describe('props', () => { - test('button', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('href', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('isDisabled', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - - test('extends EuiCardProps', () => { - const component = render( - - ); - expect(component).toMatchSnapshot(); - }); - }); -}); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx deleted file mode 100644 index 508d03d5028b8..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.tsx +++ /dev/null @@ -1,65 +0,0 @@ -/* - * 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. - */ - -import { i18n } from '@kbn/i18n'; -import React, { FunctionComponent } from 'react'; -import { EuiButton, EuiCard, EuiScreenReaderOnly } from '@elastic/eui'; - -import type { NoDataCardProps } from './types'; -import { NoDataCardStyles } from './no_data_card.styles'; - -const defaultDescription = i18n.translate( - 'sharedUXComponents.pageTemplate.noDataCard.description', - { - defaultMessage: `Proceed without collecting data`, - } -); - -export const NoDataCard: FunctionComponent = ({ - title: titleProp, - button, - description, - isDisabled, - ...cardRest -}) => { - const styles = NoDataCardStyles(); - - const footer = () => { - // Don't render the footer action if disabled - if (isDisabled) { - return; - } - // Render a custom footer action if the button is not a simple string - if (button && typeof button !== 'string') { - return button; - } - // Default footer action is a button with the provided or default string - return {button || titleProp}; - }; - - const cardDescription = description || defaultDescription; - - // Fix the need for an a11y title even though the button exists by setting to screen reader only - const title = titleProp ? ( - - {titleProp} - - ) : null; - - return ( - - ); -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts deleted file mode 100644 index fef4f654ce970..0000000000000 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/types.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* - * 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. - */ - -import { EuiCardProps } from '@elastic/eui'; -import { MouseEventHandler, ReactNode } from 'react'; - -export type NoDataCardProps = Partial> & { - /** - * Provide just a string for the button's label, or a whole component; - * The button will be hidden completely if `isDisabled=true` - */ - button?: string | ReactNode; - /** - * Remapping `onClick` to any element - */ - onClick?: MouseEventHandler; - /** - * Description for the card; - * If not provided, the default will be used - */ - description?: string | ReactNode; -}; - -export type ElasticAgentCardProps = NoDataCardProps & { - /** - * Category to auto-select within Fleet - */ - category?: string; -}; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx index c84dea27552aa..b9474285469e1 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.test.tsx @@ -7,24 +7,27 @@ */ import React from 'react'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; +import { NoDataCard } from '@kbn/shared-ux-card-no-data'; +import { SharedUxServicesProvider, mockServicesFactory } from '@kbn/shared-ux-services'; + import { NoDataPage } from './no_data_page'; -import { shallowWithIntl } from '@kbn/test-jest-helpers'; -import { ElasticAgentCard } from './no_data_card'; describe('NoDataPage', () => { test('render', () => { - const component = shallowWithIntl( - + const component = mountWithIntl( + + + ); - expect(component).toMatchSnapshot(); expect(component.find('h1').html()).toContain('Welcome to Elastic Analytics!'); - expect(component.find(ElasticAgentCard).length).toBe(1); + expect(component.find(NoDataCard).length).toBe(1); }); }); diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx index 093a76d17759f..724570d4baccd 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_page.tsx @@ -7,6 +7,7 @@ */ import React, { useMemo, FunctionComponent } from 'react'; +import useObservable from 'react-use/lib/useObservable'; import classNames from 'classnames'; import { EuiLink, EuiSpacer, EuiText, EuiTextColor } from '@elastic/eui'; @@ -14,7 +15,8 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { KibanaSolutionAvatar } from '@kbn/shared-ux-avatar-solution'; -import { ElasticAgentCard } from './no_data_card'; +import { useSharedUxServices } from '@kbn/shared-ux-services'; +import { NoDataCard, NoDataCardProvider } from '@kbn/shared-ux-card-no-data'; import { NoDataPageProps } from './types'; export const NoDataPage: FunctionComponent = ({ @@ -25,6 +27,19 @@ export const NoDataPage: FunctionComponent = ({ pageTitle, ...rest }) => { + const services = useSharedUxServices(); + + // TODO: clintandrewhall - including the `NoDataCardProvider` here is a temporary solution + // to consumers using this context to populate the NoDataPage. This will likely be removed soon, + // when NoDataPage is moved to its own package. + const currentAppId = useObservable(services.application.currentAppId$); + const noDataCardServices = { + currentAppId, + addBasePath: services.http.addBasePath, + canAccessFleet: services.permissions.canAccessFleet, + navigateToUrl: services.application.navigateToUrl, + }; + const actionKeys = Object.keys(action); const actionCard = useMemo(() => { @@ -34,7 +49,7 @@ export const NoDataPage: FunctionComponent = ({ const actionKey = actionKeys[0]; const key = actionKey === 'elasticAgent' ? 'empty-page-agent-action' : `empty-page-${actionKey}-action`; - return ; + return ; }, [action, actionKeys]); const title = @@ -74,7 +89,7 @@ export const NoDataPage: FunctionComponent = ({ - {actionCard} + {actionCard}
); }; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts b/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts index b304a1462a278..e22f7a7b81a77 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts @@ -7,9 +7,9 @@ */ import { CommonProps } from '@elastic/eui'; -import { ElasticAgentCardProps } from './no_data_card'; +import { NoDataCardProps } from '@kbn/shared-ux-card-no-data'; -export type NoDataPageActions = ElasticAgentCardProps; +export type NoDataPageActions = NoDataCardProps; export interface NoDataPageProps extends CommonProps { /** diff --git a/packages/kbn-shared-ux-storybook/src/config/main.ts b/packages/kbn-shared-ux-storybook/src/config/main.ts index ccd0d1e73cba8..6e57ca8ad5e72 100644 --- a/packages/kbn-shared-ux-storybook/src/config/main.ts +++ b/packages/kbn-shared-ux-storybook/src/config/main.ts @@ -15,4 +15,7 @@ module.exports = { '../../../kbn-shared-ux*/**/*.stories.+(tsx|mdx)', '../../../../src/plugins/shared_ux/**/*.stories.+(tsx|mdx)', ], + reactOptions: { + strictMode: true, + }, }; diff --git a/packages/kbn-storybook/src/lib/decorators.tsx b/packages/kbn-storybook/src/lib/decorators.tsx index 24af828754248..41d335be60d01 100644 --- a/packages/kbn-storybook/src/lib/decorators.tsx +++ b/packages/kbn-storybook/src/lib/decorators.tsx @@ -23,6 +23,7 @@ const EuiProviderDecorator: DecoratorFn = (storyFn, { globals }) => { key: 'eui-styles', container: document.querySelector(`meta[name="eui-styles-global"]`) as HTMLElement, }); + emotionCache.compat = true; return ( diff --git a/packages/kbn-test/src/index.ts b/packages/kbn-test/src/index.ts index c9f0e67c558f1..ea4cfb0cd0fba 100644 --- a/packages/kbn-test/src/index.ts +++ b/packages/kbn-test/src/index.ts @@ -15,6 +15,8 @@ import { // @ts-ignore not typed yet } from './functional_tests/cli'; +export { KbnClientRequesterError } from './kbn_client/kbn_client_requester_error'; + // @internal export { runTestsCli, processRunTestsCliOptions, startServersCli, processStartServersCliOptions }; diff --git a/packages/kbn-test/src/jest/setup/emotion.js b/packages/kbn-test/src/jest/setup/emotion.js index dc135f4e56c5a..8a5e90e0c53b4 100644 --- a/packages/kbn-test/src/jest/setup/emotion.js +++ b/packages/kbn-test/src/jest/setup/emotion.js @@ -12,3 +12,18 @@ module.exports = createSerializer({ classNameReplacer: (className) => className, includeStyles: false, }); + +const consoleError = console.error; +console.error = (message, ...rest) => { + // @see https://github.com/emotion-js/emotion/issues/1105 + // This error that Emotion throws doesn't apply to Jest, so + // we're just going to remove the first/nth-child warning + if ( + typeof message === 'string' && + message.includes('The pseudo class') && + message.includes('is potentially unsafe when doing server-side rendering. Try changing it to') + ) { + return; + } + consoleError(message, ...rest); +}; diff --git a/packages/kbn-test/src/kbn_client/kbn_client_requester.ts b/packages/kbn-test/src/kbn_client/kbn_client_requester.ts index a57515474faf9..36a007c1c0d1c 100644 --- a/packages/kbn-test/src/kbn_client/kbn_client_requester.ts +++ b/packages/kbn-test/src/kbn_client/kbn_client_requester.ts @@ -13,6 +13,7 @@ import Qs from 'querystring'; import Axios, { AxiosResponse, ResponseType } from 'axios'; import { isAxiosRequestError, isAxiosResponseError } from '@kbn/dev-utils'; import { ToolingLog } from '@kbn/tooling-log'; +import { KbnClientRequesterError } from './kbn_client_requester_error'; const isConcliftOnGetError = (error: any) => { return ( @@ -166,7 +167,7 @@ export class KbnClientRequester { continue; } - throw new Error(`${errorMessage} -- and ran out of retries`); + throw new KbnClientRequesterError(`${errorMessage} -- and ran out of retries`, error); } } } diff --git a/packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts b/packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts new file mode 100644 index 0000000000000..d338b24cd16ad --- /dev/null +++ b/packages/kbn-test/src/kbn_client/kbn_client_requester_error.ts @@ -0,0 +1,21 @@ +/* + * 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. + */ + +import { AxiosError } from 'axios'; + +export class KbnClientRequesterError extends Error { + axiosError?: AxiosError; + constructor(message: string, error: unknown) { + super(message); + this.name = 'KbnClientRequesterError'; + + if (error instanceof AxiosError) { + this.axiosError = error; + } + } +} diff --git a/packages/shared-ux/card/no_data/BUILD.bazel b/packages/shared-ux/card/no_data/BUILD.bazel new file mode 100644 index 0000000000000..ae3e21ba55247 --- /dev/null +++ b/packages/shared-ux/card/no_data/BUILD.bazel @@ -0,0 +1,143 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "no_data" +PKG_REQUIRE_NAME = "@kbn/shared-ux-card-no-data" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + "src/**/*.mdx", + "src/**/*.svg", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "@npm//@elastic/eui", + "@npm//@storybook/addon-actions", + "@npm//enzyme", + "@npm//react", + "//packages/kbn-i18n-react", + "//packages/kbn-i18n", + "//packages/shared-ux/link/redirect_app", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@elastic/eui", + "@npm//@storybook/addon-actions", + "@npm//@types/enzyme", + "@npm//@types/jest", + "@npm//@types/node", + "@npm//@types/react", + "//packages/kbn-ambient-ui-types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/kbn-i18n:npm_module_types", + "//packages/shared-ux/link/redirect_app:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, + additional_args = [ + "--copy-files", + "--quiet" + ], +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/shared-ux/card/no_data/README.mdx b/packages/shared-ux/card/no_data/README.mdx new file mode 100644 index 0000000000000..e2b044c27ac44 --- /dev/null +++ b/packages/shared-ux/card/no_data/README.mdx @@ -0,0 +1,29 @@ +--- +id: sharedUX/Components/NoDataCard +slug: /shared-ux/components/no-data-card +title: No Data Card +summary: A card displayed when no data is available is available in Kibana. +tags: ['shared-ux', 'component'] +date: 2022-06-15 +--- + +## Description + +A wrapper around `EuiCard` tailored for use in Kibana solutions when no data is available. + +## Usage + +All of the `EuiCard` props are available with the exception of `layout`. A default `description` and `button` are provided, but can be overridden in specific use cases. + +The `NoDataCard` connected component uses: + +- `navLinks.integrations` from `coreStart.application.capabilities` to determine if the user has access to the Integrations page. +- `addBasePath` from `coreStart` to navigate to the Integrations page. + +## API +| Export | Description | +|---|---| +| `NoDataCardProvider` | Provides contextual services to `NoDataCard`. | +| `NoDataCardKibanaProvider` | Maps Kibana dependencies to provide contextual services to `NoDataCard`. | +| `NoDataCard` | Uses a `Provider` to access contextual services to populate props on the `NoDataCardComponent`. | +| `NoDataCardComponent` | The pure component, a pre-configured **EuiCard**. | \ No newline at end of file diff --git a/packages/shared-ux/card/no_data/jest.config.js b/packages/shared-ux/card/no_data/jest.config.js new file mode 100644 index 0000000000000..47ce28115535f --- /dev/null +++ b/packages/shared-ux/card/no_data/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/shared-ux/card/no_data'], +}; diff --git a/packages/shared-ux/card/no_data/package.json b/packages/shared-ux/card/no_data/package.json new file mode 100644 index 0000000000000..a1d3efd5a6985 --- /dev/null +++ b/packages/shared-ux/card/no_data/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/shared-ux-card-no-data", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap new file mode 100644 index 0000000000000..17eb4ef8804cd --- /dev/null +++ b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.component.test.tsx.snap @@ -0,0 +1,117 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`NoDataCardComponent props button 1`] = ` + + Button + + } + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent props href 1`] = ` + + Add Elastic Agent + + } + href="some path" + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent renders 1`] = ` + + Add Elastic Agent + + } + image={} + isDisabled={false} + paddingSize="l" + title={ + + + Add Elastic Agent + + + } +/> +`; + +exports[`NoDataCardComponent renders with canAccessFleet false 1`] = ` + + This integration is not yet enabled. Your administrator has the required permissions to turn it on. + + } + image={} + isDisabled={true} + paddingSize="l" + title={ + + Contact your administrator + + } +/> +`; diff --git a/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap new file mode 100644 index 0000000000000..92e0c62af3de6 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/__snapshots__/no_data_card.test.tsx.snap @@ -0,0 +1,356 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`NoDataCard props button 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props extends EuiCardProps 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props href 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; + +exports[`NoDataCard props no access to Fleet 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + +
+

+ + This integration is not yet enabled. Your administrator has the required permissions to turn it on. + +

+
+
+
+
+`; + +exports[`NoDataCard renders 1`] = ` +
+
+
+
+
+ +
+
+
+
+ + + + Card title + + + +
+

+ Description +

+
+
+
+ +
+
+
+`; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/assets/elastic_agent_card.svg b/packages/shared-ux/card/no_data/src/assets/elastic_agent_card.svg similarity index 100% rename from packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/assets/elastic_agent_card.svg rename to packages/shared-ux/card/no_data/src/assets/elastic_agent_card.svg diff --git a/packages/shared-ux/card/no_data/src/index.ts b/packages/shared-ux/card/no_data/src/index.ts new file mode 100644 index 0000000000000..24463007b5a8c --- /dev/null +++ b/packages/shared-ux/card/no_data/src/index.ts @@ -0,0 +1,19 @@ +/* + * 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 { NoDataCard } from './no_data_card'; +export type { Props as NoDataCardProps } from './no_data_card'; + +export { NoDataCardKibanaProvider, NoDataCardProvider } from './services'; +export type { NoDataCardKibanaDependencies, NoDataCardServices } from './services'; + +export { + getMockServices as getNoDataCardMockServices, + getStoryArgTypes as getNoDataCardStoryArgTypes, + getStoryServices as getNoDataCardStoryServices, +} from './mocks'; diff --git a/packages/shared-ux/card/no_data/src/mocks.ts b/packages/shared-ux/card/no_data/src/mocks.ts new file mode 100644 index 0000000000000..d5ec849e1456b --- /dev/null +++ b/packages/shared-ux/card/no_data/src/mocks.ts @@ -0,0 +1,88 @@ +/* + * 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. + */ + +import { action } from '@storybook/addon-actions'; +import { + getRedirectAppLinksMockServices, + getRedirectAppLinksStoryArgTypes, + getRedirectAppLinksStoryServices, +} from '@kbn/shared-ux-link-redirect-app'; + +import { NoDataCardServices } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; + +/** + * Returns Storybook-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getStoryServices = (params: Params) => { + const services: NoDataCardServices = { + ...getRedirectAppLinksStoryServices(), + ...params, + addBasePath: (path) => { + action('addBasePath')(path); + return path; + }, + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `NoDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({ + ...getRedirectAppLinksStoryArgTypes(), + canAccessFleet: { + control: 'boolean', + defaultValue: true, + }, + category: { + control: { + type: 'text', + }, + defaultValue: '', + }, + title: { + control: { + type: 'text', + }, + defaultValue: '', + }, + description: { + control: { + type: 'text', + }, + defaultValue: '', + }, + button: { + control: { + type: 'text', + }, + defaultValue: '', + }, +}); + +/** + * Returns the Jest-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getMockServices = (params?: Params) => { + const { canAccessFleet } = params || { canAccessFleet: true }; + + const services: NoDataCardServices = { + ...getRedirectAppLinksMockServices(), + canAccessFleet, + addBasePath: (path) => path, + }; + + return services; +}; diff --git a/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx b/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx new file mode 100644 index 0000000000000..72d179602e6d5 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.component.test.tsx @@ -0,0 +1,36 @@ +/* + * 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. + */ + +import React from 'react'; +import { shallow } from 'enzyme'; + +import { NoDataCard } from './no_data_card.component'; + +describe('NoDataCardComponent', () => { + test('renders', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + test('renders with canAccessFleet false', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + describe('props', () => { + test('button', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + + test('href', () => { + const component = shallow(); + expect(component).toMatchSnapshot(); + }); + }); +}); diff --git a/packages/shared-ux/card/no_data/src/no_data_card.component.tsx b/packages/shared-ux/card/no_data/src/no_data_card.component.tsx new file mode 100644 index 0000000000000..43c4e9cd3a4af --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.component.tsx @@ -0,0 +1,136 @@ +/* + * 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. + */ + +import React, { MouseEventHandler, ReactNode } from 'react'; +import { + EuiButton, + EuiCard, + EuiScreenReaderOnly, + EuiTextColor, + EuiCardProps, + EuiImage, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { NoDataCardStyles } from './no_data_card.styles'; +import ElasticAgentCardIllustration from './assets/elastic_agent_card.svg'; + +export type Props = Partial< + Omit +> & { + /** + * Provide just a string for the button's label, or a whole component; + * The button will be hidden completely if `isDisabled=true` + */ + button?: string | ReactNode; + /** Remapping `onClick` to any element */ + onClick?: MouseEventHandler; + /** + * Description for the card; + * If not provided, the default will be used + */ + description?: string | ReactNode; + /** Category to auto-select within Fleet */ + category?: string; + /** True if the person has permission to access Fleet, false otherwise */ + canAccessFleet?: boolean; +}; + +const noPermissionTitle = i18n.translate('sharedUXPackages.card.noData.noPermission.title', { + defaultMessage: `Contact your administrator`, +}); + +const noPermissionDescription = i18n.translate( + 'sharedUXPackages.card.noData.noPermission.description', + { + defaultMessage: `This integration is not yet enabled. Your administrator has the required permissions to turn it on.`, + } +); + +const defaultTitle = i18n.translate('sharedUXPackages.card.noData.title', { + defaultMessage: 'Add Elastic Agent', +}); + +const defaultDescription = i18n.translate('sharedUXPackages.card.noData.description', { + defaultMessage: `Use Elastic Agent for a simple, unified way to collect data from your machines.`, +}); + +const Image = () => ( + +); + +/** + * Creates a specific NoDataCard pointing users to Integrations when `canAccessFleet` + */ +export const NoDataCard = ({ + title: titleProp, + description: descriptionProp, + canAccessFleet, + button, + ...props +}: Props) => { + const styles = NoDataCardStyles(); + + const footer = () => { + // Don't render the footer action if disabled + if (!canAccessFleet) { + return; + } + + // Render a custom footer action if the button is not a simple string + if (button && typeof button !== 'string') { + return button; + } + + // Default footer action is a button with the provided or default string + return {button || titleProp || defaultTitle}; + }; + + const title = () => { + if (!canAccessFleet) { + return {noPermissionTitle}; + } + + return ( + + {titleProp || defaultTitle} + + ); + }; + + const description = () => { + if (!canAccessFleet) { + return {noPermissionDescription}; + } + + return descriptionProp || defaultDescription; + }; + + return ( + } + {...props} + /> + ); +}; diff --git a/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx b/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx new file mode 100644 index 0000000000000..38f299d3d3d35 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.stories.tsx @@ -0,0 +1,45 @@ +/* + * 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. + */ + +import React from 'react'; + +import { Params, getStoryArgTypes, getStoryServices } from './mocks'; + +import { NoDataCard as Component } from './no_data_card.component'; +import { NoDataCard as ConnectedComponent } from './no_data_card'; +import { NoDataCardProvider } from './services'; + +import mdx from '../README.mdx'; + +export default { + title: 'No Data/Card', + description: 'A solution-specific wrapper around `EuiCard`, to be used on `NoData` page', + parameters: { + docs: { + page: mdx, + }, + }, +}; + +const argTypes = getStoryArgTypes(); + +export const NoDataCard = (params: Params) => { + return ( + + + + ); +}; + +NoDataCard.argTypes = argTypes; + +export const NoDataCardComponent = (params: Params) => { + return ; +}; + +NoDataCardComponent.argTypes = argTypes; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.styles.ts b/packages/shared-ux/card/no_data/src/no_data_card.styles.ts similarity index 100% rename from packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_card/no_data_card.styles.ts rename to packages/shared-ux/card/no_data/src/no_data_card.styles.ts diff --git a/packages/shared-ux/card/no_data/src/no_data_card.test.tsx b/packages/shared-ux/card/no_data/src/no_data_card.test.tsx new file mode 100644 index 0000000000000..0f659ad7a7f50 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.test.tsx @@ -0,0 +1,66 @@ +/* + * 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. + */ + +import { render as enzymeRender } from 'enzyme'; +import React from 'react'; + +import { NoDataCard } from './no_data_card'; +import { NoDataCardProvider } from './services'; + +const services = { + addBasePath: (path: string) => path, + navigateToUrl: () => {}, +}; + +describe('NoDataCard', () => { + const render = (element: React.ReactElement, canAccessFleet: boolean = true) => + enzymeRender( + {element} + ); + + test('renders', () => { + const component = render(); + expect(component).toMatchSnapshot(); + }); + + describe('props', () => { + test('button', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + + test('href', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + + test('no access to Fleet', () => { + const component = render( + , + false + ); + expect(component).toMatchSnapshot(); + }); + + test('extends EuiCardProps', () => { + const component = render( + + ); + expect(component).toMatchSnapshot(); + }); + }); +}); diff --git a/packages/shared-ux/card/no_data/src/no_data_card.tsx b/packages/shared-ux/card/no_data/src/no_data_card.tsx new file mode 100644 index 0000000000000..a58ee5bc9d08b --- /dev/null +++ b/packages/shared-ux/card/no_data/src/no_data_card.tsx @@ -0,0 +1,41 @@ +/* + * 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. + */ + +import React, { useMemo } from 'react'; +import { RedirectAppLinksContainer } from '@kbn/shared-ux-link-redirect-app'; + +import { NoDataCard as Component, Props as ComponentProps } from './no_data_card.component'; + +import { useServices } from './services'; + +export type Props = Omit; + +export const NoDataCard = ({ href: srcHref, category, description, ...props }: Props) => { + const { canAccessFleet, addBasePath } = useServices(); + + const href = useMemo(() => { + if (srcHref) { + return srcHref; + } + + // TODO: get this URL from a locator + const prefix = '/app/integrations/browse'; + + if (category) { + return addBasePath(`${prefix}/${category}`); + } + + return addBasePath(prefix); + }, [addBasePath, srcHref, category]); + + return ( + + + + ); +}; diff --git a/packages/shared-ux/card/no_data/src/services.tsx b/packages/shared-ux/card/no_data/src/services.tsx new file mode 100644 index 0000000000000..c4937a6d21da9 --- /dev/null +++ b/packages/shared-ux/card/no_data/src/services.tsx @@ -0,0 +1,97 @@ +/* + * 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. + */ + +import React, { FC, useContext } from 'react'; +import { + RedirectAppLinksServices, + RedirectAppLinksKibanaDependencies, + RedirectAppLinksProvider, + RedirectAppLinksKibanaProvider, +} from '@kbn/shared-ux-link-redirect-app'; + +/** + * A list of services that are consumed by this component. + */ +interface Services { + addBasePath: (path: string) => string; + canAccessFleet: boolean; +} + +const Context = React.createContext(null); + +/** + * Services that are consumed by this component and its dependencies. + */ +export type NoDataCardServices = Services & RedirectAppLinksServices; + +/** + * A Context Provider that provides services to the component and its dependencies. + */ +export const NoDataCardProvider: FC = ({ children, ...services }) => { + const { addBasePath, canAccessFleet } = services; + + return ( + + {children} + + ); +}; + +interface KibanaDependencies { + coreStart: { + http: { + basePath: { + prepend: (path: string) => string; + }; + }; + application: { + capabilities: { + navLinks: Record; + }; + }; + }; +} +/** + * An interface containing a collection of Kibana plugins and services required to + * render this component as well as its dependencies. + */ +export type NoDataCardKibanaDependencies = KibanaDependencies & RedirectAppLinksKibanaDependencies; + +/** + * Kibana-specific Provider that maps dependencies to services. + */ +export const NoDataCardKibanaProvider: FC = ({ + children, + ...dependencies +}) => { + const value: Services = { + addBasePath: dependencies.coreStart.http.basePath.prepend, + canAccessFleet: dependencies.coreStart.application.capabilities.navLinks.integrations, + }; + + return ( + + {children} + + ); +}; + +/** + * React hook for accessing pre-wired services. + */ +export function useServices() { + const context = useContext(Context); + + if (!context) { + throw new Error( + 'NoDataCard Context is missing. Ensure your component or React root is wrapped with NoDataCardContext.' + ); + } + + return context; +} diff --git a/packages/shared-ux/card/no_data/tsconfig.json b/packages/shared-ux/card/no_data/tsconfig.json new file mode 100644 index 0000000000000..44b240540718d --- /dev/null +++ b/packages/shared-ux/card/no_data/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node", + "react", + "@emotion/react/types/css-prop", + "@kbn/ambient-ui-types" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/shared-ux/link/redirect_app/src/index.tsx b/packages/shared-ux/link/redirect_app/src/index.tsx index 09317ebab59f7..0d1c61242edb3 100644 --- a/packages/shared-ux/link/redirect_app/src/index.tsx +++ b/packages/shared-ux/link/redirect_app/src/index.tsx @@ -10,16 +10,27 @@ export { RedirectAppLinks as RedirectAppLinksContainer } from './redirect_app_li export { RedirectAppLinks as RedirectAppLinksComponent } from './redirect_app_links.component'; export { RedirectAppLinksKibanaProvider, RedirectAppLinksProvider } from './services'; +export type { + Services as RedirectAppLinksServices, + KibanaDependencies as RedirectAppLinksKibanaDependencies, +} from './services'; + +export { + getMockServices as getRedirectAppLinksMockServices, + getStoryArgTypes as getRedirectAppLinksStoryArgTypes, + getStoryServices as getRedirectAppLinksStoryServices, +} from './mocks'; + import React, { FC } from 'react'; import { RedirectAppLinks as RedirectAppLinksContainer } from './redirect_app_links'; import { Services, - KibanaServices, + KibanaDependencies, RedirectAppLinksKibanaProvider, RedirectAppLinksProvider, } from './services'; -const isKibanaContract = (services: any): services is KibanaServices => { +const isKibanaContract = (services: any): services is KibanaDependencies => { return typeof services.coreStart !== 'undefined'; }; @@ -28,12 +39,22 @@ const isKibanaContract = (services: any): services is KibanaServices => { * `RedirectAppLinksKibanaProvider` based on the services provided, creating a single component * with which consumers can wrap their components or solutions. */ -export const RedirectAppLinks: FC = ({ children, ...services }) => { +export const RedirectAppLinks: FC = ({ children, ...services }) => { const container = {children}; - return isKibanaContract(services) ? ( - {container} - ) : ( - {container} + if (isKibanaContract(services)) { + const { coreStart } = services; + return ( + + {container} + + ); + } + + const { navigateToUrl, currentAppId } = services; + return ( + + {container} + ); }; diff --git a/packages/shared-ux/link/redirect_app/src/mocks.ts b/packages/shared-ux/link/redirect_app/src/mocks.ts new file mode 100644 index 0000000000000..4b5519dd646bb --- /dev/null +++ b/packages/shared-ux/link/redirect_app/src/mocks.ts @@ -0,0 +1,46 @@ +/* + * 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. + */ + +import { action } from '@storybook/addon-actions'; + +import { Services } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; + +/** + * Returns Storybook-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getStoryServices = () => { + const services: Services = { + navigateToUrl: action('navigateToUrl'), + currentAppId: 'currentAppId', + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `NoDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({}); + +/** + * Returns the Jest-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getMockServices = () => { + const services: Services = { + navigateToUrl: jest.fn(), + currentAppId: 'currentAppId', + }; + + return services; +}; diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx index 477471fe71824..f0da5b307fbd1 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.component.tsx @@ -29,12 +29,7 @@ export interface Props extends DetailedHTMLProps, * * ``` */ -export const RedirectAppLinks: FC = ({ - children, - navigateToUrl, - currentAppId, - ...otherProps -}) => { +export const RedirectAppLinks: FC = ({ children, navigateToUrl, currentAppId }) => { const containerRef = useRef(null); const handleClick: MouseEventHandler = useCallback( @@ -50,7 +45,7 @@ export const RedirectAppLinks: FC = ({ return ( // eslint-disable-next-line jsx-a11y/click-events-have-key-events -
+
{children}
); diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx index 9bb3d0d9782d4..1b77f7148964e 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.stories.tsx @@ -10,11 +10,12 @@ import { EuiButton, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import React from 'react'; import { action } from '@storybook/addon-actions'; -import { RedirectAppLinks } from '.'; +import { RedirectAppLinks as Component } from '.'; +import { getStoryArgTypes, getStoryServices } from './mocks'; import mdx from '../README.mdx'; export default { - title: 'Redirect App Links', + title: 'Link', description: 'An "area of effect" component which intercepts clicks on anchor elements and redirects them to Kibana solutions without a page refresh.', parameters: { @@ -24,16 +25,10 @@ export default { }, }; -export const Component = () => { - const navigateToUrl = async (url: string) => { - action('navigateToUrl')(url); - }; - - const currentAppId = 'abc123'; - +export const RedirectAppLinks = () => { return ( <> - + { - + { ); }; + +RedirectAppLinks.argTypes = getStoryArgTypes(); diff --git a/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx b/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx index 1e805ad4475b6..9a069881b2128 100644 --- a/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx +++ b/packages/shared-ux/link/redirect_app/src/redirect_app_links.tsx @@ -6,15 +6,10 @@ * Side Public License, v 1. */ -import React from 'react'; +import React, { FC } from 'react'; import { useServices } from './services'; -import { - RedirectAppLinks as Component, - Props as ComponentProps, -} from './redirect_app_links.component'; - -type Props = Omit; +import { RedirectAppLinks as Component } from './redirect_app_links.component'; /** * A service-enabled component that provides Kibana-specific functionality to the `RedirectAppLinks` @@ -27,4 +22,6 @@ type Props = Omit; * * ``` */ -export const RedirectAppLinks = (props: Props) => ; +export const RedirectAppLinks: FC<{}> = ({ children }) => ( + {children} +); diff --git a/packages/shared-ux/link/redirect_app/src/services.tsx b/packages/shared-ux/link/redirect_app/src/services.tsx index 22bc5a5cd0c55..b29d82f8eea13 100644 --- a/packages/shared-ux/link/redirect_app/src/services.tsx +++ b/packages/shared-ux/link/redirect_app/src/services.tsx @@ -25,8 +25,9 @@ const RedirectAppLinksContext = React.createContext(null); * Contextual services Provider. */ export const RedirectAppLinksProvider: FC = ({ children, ...services }) => { + const { navigateToUrl, currentAppId } = services; return ( - + {children} ); @@ -35,7 +36,7 @@ export const RedirectAppLinksProvider: FC = ({ children, ...services } /** * Kibana-specific contextual services to be adapted for this component. */ -export interface KibanaServices { +export interface KibanaDependencies { coreStart: { application: { currentAppId$: Observable; @@ -47,7 +48,7 @@ export interface KibanaServices { /** * Kibana-specific contextual services Provider. */ -export const RedirectAppLinksKibanaProvider: FC = ({ children, coreStart }) => { +export const RedirectAppLinksKibanaProvider: FC = ({ children, coreStart }) => { const { navigateToUrl, currentAppId$ } = coreStart.application; const currentAppId = useObservable(currentAppId$, undefined); diff --git a/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx b/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx index d5d82d801fc8d..8cb9b3aaa5f7e 100644 --- a/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx +++ b/packages/shared-ux/page/analytics_no_data/src/analytics_no_data_page.stories.tsx @@ -16,7 +16,7 @@ import mdx from '../README.mdx'; import { Params, getStoryArgTypes, getStoryServices } from './mocks'; export default { - title: 'No Data/Analytics', + title: 'No Data/Analytics Page', description: 'An Analytics-specific version of KibanaNoDataPage.', parameters: { docs: { diff --git a/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx b/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx index 206b958e64771..c18adc20e4af0 100644 --- a/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx +++ b/packages/shared-ux/page/kibana_no_data/src/kibana_no_data_page.stories.tsx @@ -16,7 +16,7 @@ import { KibanaNoDataPageProvider } from './services'; import mdx from '../README.mdx'; export default { - title: 'No Data/Kibana', + title: 'No Data/Kibana Page', description: 'A component to display when there is no data available', parameters: { docs: { diff --git a/packages/shared-ux/page/kibana_no_data/src/mocks.ts b/packages/shared-ux/page/kibana_no_data/src/mocks.ts index e88097c933849..d91949ddc6c32 100644 --- a/packages/shared-ux/page/kibana_no_data/src/mocks.ts +++ b/packages/shared-ux/page/kibana_no_data/src/mocks.ts @@ -14,6 +14,12 @@ import { getNoDataViewsPromptMockServices, } from '@kbn/shared-ux-prompt-no-data-views'; +import { + getNoDataCardMockServices, + getNoDataCardStoryArgTypes, + getNoDataCardStoryServices, +} from '@kbn/shared-ux-card-no-data'; + import { KibanaNoDataPageServices } from './services'; // TODO: clintandrewhall - this looks (and is) a bit complicated because the No Data View @@ -32,6 +38,8 @@ export const getStoryServices = (params: StoryParams) => { const { canCreateNewDataView, dataViewsDocLink, openDataViewEditor } = getNoDataViewsPromptStorybookServices(params); + const { addBasePath, canAccessFleet } = getNoDataCardStoryServices(params); + // Workaround to leverage the services package. const { application, data, docLinks, editors, http, permissions, platform } = servicesFactory(params); @@ -47,6 +55,8 @@ export const getStoryServices = (params: StoryParams) => { canCreateNewDataView, dataViewsDocLink, openDataViewEditor, + addBasePath, + canAccessFleet, }; return services; @@ -75,6 +85,7 @@ export const getStoryArgTypes = () => ({ defaultValue: false, }, ...getNoDataViewsPromptStoryArgTypes(), + ...getNoDataCardStoryArgTypes(), }); /** @@ -84,6 +95,8 @@ export const getMockServices = (params?: MockServicesFactoryParams) => { const { canCreateNewDataView, dataViewsDocLink, openDataViewEditor } = getNoDataViewsPromptMockServices(); + const { addBasePath, canAccessFleet } = getNoDataCardMockServices(); + const { application, data, docLinks, editors, http, permissions, platform } = mockServicesFactory(params); @@ -98,6 +111,8 @@ export const getMockServices = (params?: MockServicesFactoryParams) => { canCreateNewDataView, dataViewsDocLink, openDataViewEditor, + addBasePath, + canAccessFleet, }; return services; diff --git a/packages/shared-ux/page/kibana_no_data/src/services.tsx b/packages/shared-ux/page/kibana_no_data/src/services.tsx index 07b5787ae8b72..47f6b9c3690f9 100644 --- a/packages/shared-ux/page/kibana_no_data/src/services.tsx +++ b/packages/shared-ux/page/kibana_no_data/src/services.tsx @@ -13,6 +13,8 @@ import { NoDataViewsPromptKibanaProvider, } from '@kbn/shared-ux-prompt-no-data-views'; +import { NoDataCardProvider, NoDataCardKibanaProvider } from '@kbn/shared-ux-card-no-data'; + import { LegacyServicesProvider, getLegacyServices } from './legacy_services'; /** @@ -85,7 +87,9 @@ export const KibanaNoDataPageProvider: FC = ({ }) => ( - {children} + + {children} + ); @@ -159,7 +163,9 @@ export const KibanaNoDataPageKibanaProvider: FC - {children} + + {children} + ); diff --git a/scripts/check_published_api_changes.js b/scripts/check_published_api_changes.js deleted file mode 100644 index 44d98ca51361b..0000000000000 --- a/scripts/check_published_api_changes.js +++ /dev/null @@ -1,10 +0,0 @@ -/* - * 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. - */ - -require('../src/setup_node_env'); -require('../src/dev/run_check_published_api_changes'); diff --git a/scripts/report_performance_metrics.js b/scripts/report_performance_metrics.js new file mode 100644 index 0000000000000..8fc7e5c4b52a3 --- /dev/null +++ b/scripts/report_performance_metrics.js @@ -0,0 +1,10 @@ +/* + * 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. + */ + +require('../src/setup_node_env'); +require('@kbn/ci-stats-performance-metrics').runCli(); diff --git a/src/core/README.md b/src/core/README.md index 4dd045f37b483..08dd2f49f7f72 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -32,17 +32,3 @@ by the "legacy" Kibana may be rejected by the `core` now. `core` has its own [logging system](./server/logging/README.mdx) and will output log records directly (e.g. to file or terminal) when configured. When no specific configuration is provided, logs are forwarded to the "legacy" Kibana so that they look the same as the rest of the log records throughout Kibana. - -## Core API Review -To provide a stable API for plugin developers, it is important that the Core Public and Server API's are stable and -well documented. To reduce the chance of regressions, development on the Core API's includes an API signature review -process described below. Changes to the API signature which have not been accepted will cause the build to fail. - -When changes to the Core API's signatures are made, the following process needs to be followed: -1. After changes have been made, run `yarn docs:acceptApiChanges` which performs the following: - - Recompiles all typescript typings files - - Updates the API review files `src/core/public/kibana.api.md` and `src/core/server/kibana.api.md` - - Updates the Core API documentation in `docs/development/core/` -2. Review and commit the updated API Review files and documentation -3. Clearly flag any breaking changes in your pull request - diff --git a/src/core/public/chrome/ui/header/__snapshots__/collapsible_nav.test.tsx.snap b/src/core/public/chrome/ui/header/__snapshots__/collapsible_nav.test.tsx.snap index 404df945ae561..5cc46d20dc3a6 100644 --- a/src/core/public/chrome/ui/header/__snapshots__/collapsible_nav.test.tsx.snap +++ b/src/core/public/chrome/ui/header/__snapshots__/collapsible_nav.test.tsx.snap @@ -104,12 +104,12 @@ Array [ data-test-subj="collapsibleNavGroup-recentlyViewed" >
({ export const MockI18nService = i18nServiceMock.create(); export const I18nServiceConstructor = jest.fn().mockImplementation(() => MockI18nService); -jest.doMock('./i18n', () => ({ +jest.doMock('@kbn/core-i18n-browser-internal', () => ({ I18nService: I18nServiceConstructor, })); diff --git a/src/core/public/core_system.test.ts b/src/core/public/core_system.test.ts index 2a57364c9f93f..76f972d174ce8 100644 --- a/src/core/public/core_system.test.ts +++ b/src/core/public/core_system.test.ts @@ -70,6 +70,19 @@ const defaultCoreSystemParams = { beforeEach(() => { jest.clearAllMocks(); MockPluginsService.getOpaqueIds.mockReturnValue(new Map()); + + window.performance.mark = jest.fn(); + window.performance.clearMarks = jest.fn(); + window.performance.getEntriesByName = jest.fn().mockReturnValue([ + { + detail: 'load_started', + startTime: 456, + }, + { + detail: 'bootstrap_started', + startTime: 123, + }, + ]); }); function createCoreSystem(params = {}) { @@ -221,7 +234,9 @@ describe('#start()', () => { }); await core.setup(); - await core.start(); + + const services = await core.start(); + await services?.application.navigateToApp('home'); } it('clears the children of the rootDomElement and appends container for rendering service with #kibana-body, notifications, overlays', async () => { @@ -233,16 +248,22 @@ describe('#start()', () => { ); }); - it('reports the event Loaded Kibana', async () => { + it('reports the event Loaded Kibana and clears marks', async () => { await startCore(); expect(analyticsServiceStartMock.reportEvent).toHaveBeenCalledTimes(1); expect(analyticsServiceStartMock.reportEvent).toHaveBeenCalledWith('Loaded Kibana', { kibana_version: '1.2.3', + load_started: 456, + bootstrap_started: 123, }); + + expect(window.performance.clearMarks).toHaveBeenCalledTimes(1); }); it('reports the event Loaded Kibana (with memory)', async () => { fetchOptionalMemoryInfoMock.mockReturnValue({ + load_started: 456, + bootstrap_started: 123, memory_js_heap_size_limit: 3, memory_js_heap_size_total: 2, memory_js_heap_size_used: 1, @@ -251,6 +272,8 @@ describe('#start()', () => { await startCore(); expect(analyticsServiceStartMock.reportEvent).toHaveBeenCalledTimes(1); expect(analyticsServiceStartMock.reportEvent).toHaveBeenCalledWith('Loaded Kibana', { + load_started: 456, + bootstrap_started: 123, kibana_version: '1.2.3', memory_js_heap_size_limit: 3, memory_js_heap_size_total: 2, diff --git a/src/core/public/core_system.ts b/src/core/public/core_system.ts index b49849d84eccd..bdf94d953b659 100644 --- a/src/core/public/core_system.ts +++ b/src/core/public/core_system.ts @@ -15,13 +15,13 @@ import { } from '@kbn/core-injected-metadata-browser-internal'; import { DocLinksService } from '@kbn/core-doc-links-browser-internal'; import { ThemeService } from '@kbn/core-theme-browser-internal'; -import type { AnalyticsServiceSetup } from '@kbn/core-analytics-browser'; +import type { AnalyticsServiceSetup, AnalyticsServiceStart } from '@kbn/core-analytics-browser'; import { AnalyticsService } from '@kbn/core-analytics-browser-internal'; +import { I18nService } from '@kbn/core-i18n-browser-internal'; import { CoreSetup, CoreStart } from '.'; import { ChromeService } from './chrome'; import { FatalErrorsService, FatalErrorsSetup } from './fatal_errors'; import { HttpService } from './http'; -import { I18nService } from './i18n'; import { NotificationsService } from './notifications'; import { OverlayService } from './overlays'; import { PluginsService } from './plugins'; @@ -35,6 +35,7 @@ import { CoreApp } from './core_app'; import type { InternalApplicationSetup, InternalApplicationStart } from './application/types'; import { ExecutionContextService } from './execution_context'; import { fetchOptionalMemoryInfo } from './fetch_optional_memory_info'; +import { KBN_LOAD_MARKS } from './utils'; interface Params { rootDomElement: HTMLElement; @@ -124,6 +125,30 @@ export class CoreSystem { this.plugins = new PluginsService(this.coreContext, injectedMetadata.uiPlugins); this.coreApp = new CoreApp(this.coreContext); + + performance.mark(KBN_LOAD_MARKS, { + detail: 'core_created', + }); + } + + private getLoadMarksInfo() { + if (!performance) return []; + const reportData: Record = {}; + const marks = performance.getEntriesByName(KBN_LOAD_MARKS); + for (const mark of marks) { + reportData[(mark as PerformanceMark).detail] = mark.startTime; + } + + return reportData; + } + + private reportKibanaLoadedEvent(analytics: AnalyticsServiceStart) { + analytics.reportEvent('Loaded Kibana', { + kibana_version: this.coreContext.env.packageInfo.version, + ...fetchOptionalMemoryInfo(), + ...this.getLoadMarksInfo(), + }); + performance.clearMarks(KBN_LOAD_MARKS); } public async setup() { @@ -171,6 +196,10 @@ export class CoreSystem { // Services that do not expose contracts at setup await this.plugins.setup(core); + performance.mark(KBN_LOAD_MARKS, { + detail: 'setup_done', + }); + return { fatalErrors: this.fatalErrorsSetup }; } catch (error) { if (this.fatalErrorsSetup) { @@ -267,9 +296,19 @@ export class CoreSystem { targetDomElement: coreUiTargetDomElement, }); - analytics.reportEvent('Loaded Kibana', { - kibana_version: this.coreContext.env.packageInfo.version, - ...fetchOptionalMemoryInfo(), + performance.mark(KBN_LOAD_MARKS, { + detail: 'start_done', + }); + + // Wait for the first app navigation to report Kibana Loaded + const appSub = application.currentAppId$.subscribe((appId) => { + if (appId === undefined) return; + + performance.mark(KBN_LOAD_MARKS, { + detail: 'first_app_nav', + }); + this.reportKibanaLoadedEvent(analytics); + appSub.unsubscribe(); }); return { @@ -323,6 +362,33 @@ export class CoreSystem { type: 'long', _meta: { description: 'The used size of the heap', optional: true }, }, + load_started: { + type: 'long', + _meta: { description: 'When the render template starts loading assets', optional: true }, + }, + bootstrap_started: { + type: 'long', + _meta: { description: 'When kbnBootstrap callback is called', optional: true }, + }, + core_created: { + type: 'long', + _meta: { description: 'When core system is created', optional: true }, + }, + setup_done: { + type: 'long', + _meta: { description: 'When core system setup is complete', optional: true }, + }, + start_done: { + type: 'long', + _meta: { description: 'When core system start is complete', optional: true }, + }, + first_app_nav: { + type: 'long', + _meta: { + description: 'When the application emits the first app navigation', + optional: true, + }, + }, }, }); } diff --git a/src/core/public/fatal_errors/fatal_errors_service.tsx b/src/core/public/fatal_errors/fatal_errors_service.tsx index 048c4e4b4ba8d..952740c414163 100644 --- a/src/core/public/fatal_errors/fatal_errors_service.tsx +++ b/src/core/public/fatal_errors/fatal_errors_service.tsx @@ -13,7 +13,7 @@ import { first, tap } from 'rxjs/operators'; import type { InternalInjectedMetadataSetup } from '@kbn/core-injected-metadata-browser-internal'; import type { ThemeServiceSetup } from '@kbn/core-theme-browser'; -import { I18nStart } from '../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { CoreContextProvider } from '../utils'; import { FatalErrorsScreen } from './fatal_errors_screen'; import { FatalErrorInfo, getErrorInfo } from './get_error_info'; diff --git a/src/core/public/i18n/index.ts b/src/core/public/i18n/index.ts deleted file mode 100644 index 791920dd31372..0000000000000 --- a/src/core/public/i18n/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * 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 { I18nService } from './i18n_service'; -export type { I18nStart } from './i18n_service'; diff --git a/src/core/public/index.ts b/src/core/public/index.ts index b32d872c40acf..5162cdac1024d 100644 --- a/src/core/public/index.ts +++ b/src/core/public/index.ts @@ -33,6 +33,8 @@ import type { import { DocLinksStart } from '@kbn/core-doc-links-browser'; import type { ThemeServiceSetup, ThemeServiceStart } from '@kbn/core-theme-browser'; import type { AnalyticsServiceSetup, AnalyticsServiceStart } from '@kbn/core-analytics-browser'; +import type { I18nStart } from '@kbn/core-i18n-browser'; + import { ChromeBadge, ChromeBreadcrumb, @@ -57,7 +59,6 @@ import { } from './chrome'; import { FatalErrorsSetup, FatalErrorsStart, FatalErrorInfo } from './fatal_errors'; import { HttpSetup, HttpStart } from './http'; -import { I18nStart } from './i18n'; import { NotificationsSetup, NotificationsStart } from './notifications'; import { OverlayStart } from './overlays'; import { Plugin, PluginInitializer, PluginInitializerContext, PluginOpaqueId } from './plugins'; diff --git a/src/core/public/kbn_bootstrap.test.ts b/src/core/public/kbn_bootstrap.test.ts index 03096daf09c39..f32bb21cd041a 100644 --- a/src/core/public/kbn_bootstrap.test.ts +++ b/src/core/public/kbn_bootstrap.test.ts @@ -22,6 +22,7 @@ describe('kbn_bootstrap', () => { beforeEach(() => { jest.clearAllMocks(); + window.performance.mark = jest.fn(); }); it('does not report a fatal error if apm load fails', async () => { diff --git a/src/core/public/kbn_bootstrap.ts b/src/core/public/kbn_bootstrap.ts index 38e95188f4c06..79283daaf9a3a 100644 --- a/src/core/public/kbn_bootstrap.ts +++ b/src/core/public/kbn_bootstrap.ts @@ -9,9 +9,14 @@ import { i18n } from '@kbn/i18n'; import { CoreSystem } from './core_system'; import { ApmSystem } from './apm_system'; +import { KBN_LOAD_MARKS } from './utils'; /** @internal */ export async function __kbnBootstrap__() { + performance.mark(KBN_LOAD_MARKS, { + detail: 'bootstrap_started', + }); + const injectedMetadata = JSON.parse( document.querySelector('kbn-injected-metadata')!.getAttribute('data')! ); diff --git a/src/core/public/mocks.ts b/src/core/public/mocks.ts index 6493bd7420f11..3a1f03f5ea782 100644 --- a/src/core/public/mocks.ts +++ b/src/core/public/mocks.ts @@ -14,6 +14,7 @@ import { coreContextMock } from '@kbn/core-base-browser-mocks'; import { analyticsServiceMock } from '@kbn/core-analytics-browser-mocks'; // Only import types from '.' to avoid triggering default Jest mocks. +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { PluginInitializerContext, AppMountParameters } from '.'; // Import values from their individual modules instead. import { ScopedHistory } from './application'; @@ -21,7 +22,6 @@ import { applicationServiceMock } from './application/application_service.mock'; import { chromeServiceMock } from './chrome/chrome_service.mock'; import { fatalErrorsServiceMock } from './fatal_errors/fatal_errors_service.mock'; import { httpServiceMock } from './http/http_service.mock'; -import { i18nServiceMock } from './i18n/i18n_service.mock'; import { notificationServiceMock } from './notifications/notifications_service.mock'; import { overlayServiceMock } from './overlays/overlay_service.mock'; import { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock'; @@ -37,7 +37,7 @@ export { chromeServiceMock } from './chrome/chrome_service.mock'; export { executionContextServiceMock } from './execution_context/execution_context_service.mock'; export { fatalErrorsServiceMock } from './fatal_errors/fatal_errors_service.mock'; export { httpServiceMock } from './http/http_service.mock'; -export { i18nServiceMock } from './i18n/i18n_service.mock'; +export { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; export { notificationServiceMock } from './notifications/notifications_service.mock'; export { overlayServiceMock } from './overlays/overlay_service.mock'; export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock'; diff --git a/src/core/public/notifications/notifications_service.ts b/src/core/public/notifications/notifications_service.ts index e09134944ff5d..859e21de5ffed 100644 --- a/src/core/public/notifications/notifications_service.ts +++ b/src/core/public/notifications/notifications_service.ts @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import { Subscription } from 'rxjs'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; -import { I18nStart } from '../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { ToastsService, ToastsSetup, ToastsStart } from './toasts'; import { IUiSettingsClient } from '../ui_settings'; import { OverlayStart } from '../overlays'; diff --git a/src/core/public/notifications/toasts/error_toast.tsx b/src/core/public/notifications/toasts/error_toast.tsx index 3b0a8a14f4966..bef4833d0097d 100644 --- a/src/core/public/notifications/toasts/error_toast.tsx +++ b/src/core/public/notifications/toasts/error_toast.tsx @@ -20,8 +20,8 @@ import { } from '@elastic/eui'; import { EuiSpacer } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { OverlayStart } from '../..'; -import { I18nStart } from '../../i18n'; interface ErrorToastProps { title: string; diff --git a/src/core/public/notifications/toasts/toasts_api.test.ts b/src/core/public/notifications/toasts/toasts_api.test.ts index 9130e060a37f8..d6b67bdb63f7a 100644 --- a/src/core/public/notifications/toasts/toasts_api.test.ts +++ b/src/core/public/notifications/toasts/toasts_api.test.ts @@ -11,7 +11,7 @@ import { firstValueFrom } from 'rxjs'; import { ToastsApi } from './toasts_api'; import { uiSettingsServiceMock } from '../../ui_settings/ui_settings_service.mock'; -import { i18nServiceMock } from '../../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; async function getCurrentToasts(toasts: ToastsApi) { return await firstValueFrom(toasts.get$()); diff --git a/src/core/public/notifications/toasts/toasts_api.tsx b/src/core/public/notifications/toasts/toasts_api.tsx index 5aaea1ca90a56..ecf32d442931c 100644 --- a/src/core/public/notifications/toasts/toasts_api.tsx +++ b/src/core/public/notifications/toasts/toasts_api.tsx @@ -11,12 +11,12 @@ import React from 'react'; import * as Rx from 'rxjs'; import { omitBy, isUndefined } from 'lodash'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { ErrorToast } from './error_toast'; import { MountPoint } from '../../types'; import { mountReactNode } from '../../utils'; import { IUiSettingsClient } from '../../ui_settings'; import { OverlayStart } from '../../overlays'; -import { I18nStart } from '../../i18n'; /** * Allowed fields for {@link ToastInput}. diff --git a/src/core/public/notifications/toasts/toasts_service.tsx b/src/core/public/notifications/toasts/toasts_service.tsx index 505cbb8787ca3..045da1fc24d02 100644 --- a/src/core/public/notifications/toasts/toasts_service.tsx +++ b/src/core/public/notifications/toasts/toasts_service.tsx @@ -10,7 +10,7 @@ import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; -import { I18nStart } from '../../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { IUiSettingsClient } from '../../ui_settings'; import { GlobalToastList } from './global_toast_list'; import { ToastsApi, IToasts } from './toasts_api'; diff --git a/src/core/public/overlays/banners/banners_service.test.ts b/src/core/public/overlays/banners/banners_service.test.ts index 6ab49ce1b5f15..d3093879f8715 100644 --- a/src/core/public/overlays/banners/banners_service.test.ts +++ b/src/core/public/overlays/banners/banners_service.test.ts @@ -8,7 +8,7 @@ import { OverlayBannersService, OverlayBannersStart } from './banners_service'; import { take } from 'rxjs/operators'; -import { i18nServiceMock } from '../../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { uiSettingsServiceMock } from '../../ui_settings/ui_settings_service.mock'; describe('OverlayBannersService', () => { diff --git a/src/core/public/overlays/banners/banners_service.tsx b/src/core/public/overlays/banners/banners_service.tsx index 540a46d373304..a5436d21ef45e 100644 --- a/src/core/public/overlays/banners/banners_service.tsx +++ b/src/core/public/overlays/banners/banners_service.tsx @@ -10,10 +10,10 @@ import React from 'react'; import { BehaviorSubject, Observable } from 'rxjs'; import { map } from 'rxjs/operators'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { PriorityMap } from './priority_map'; import { BannersList } from './banners_list'; import { IUiSettingsClient } from '../../ui_settings'; -import { I18nStart } from '../../i18n'; import { MountPoint } from '../../types'; import { UserBannerService } from './user_banner_service'; diff --git a/src/core/public/overlays/banners/user_banner_service.test.ts b/src/core/public/overlays/banners/user_banner_service.test.ts index ff46a03886d7e..52d6d00171261 100644 --- a/src/core/public/overlays/banners/user_banner_service.test.ts +++ b/src/core/public/overlays/banners/user_banner_service.test.ts @@ -9,7 +9,7 @@ import { uiSettingsServiceMock } from '../../ui_settings/ui_settings_service.mock'; import { UserBannerService } from './user_banner_service'; import { overlayBannersServiceMock } from './banners_service.mock'; -import { i18nServiceMock } from '../../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { Subject } from 'rxjs'; describe('OverlayBannersService', () => { diff --git a/src/core/public/overlays/banners/user_banner_service.tsx b/src/core/public/overlays/banners/user_banner_service.tsx index cb6dd81d85a7b..175d43ea8ba59 100644 --- a/src/core/public/overlays/banners/user_banner_service.tsx +++ b/src/core/public/overlays/banners/user_banner_service.tsx @@ -14,7 +14,7 @@ import { Subscription } from 'rxjs'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiCallOut, EuiButton, EuiLoadingSpinner } from '@elastic/eui'; -import { I18nStart } from '../../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { IUiSettingsClient } from '../../ui_settings'; import { OverlayBannersStart } from './banners_service'; diff --git a/src/core/public/overlays/flyout/flyout_service.test.tsx b/src/core/public/overlays/flyout/flyout_service.test.tsx index b1508153a47f1..cd7e72f2883f5 100644 --- a/src/core/public/overlays/flyout/flyout_service.test.tsx +++ b/src/core/public/overlays/flyout/flyout_service.test.tsx @@ -9,7 +9,7 @@ import { mockReactDomRender, mockReactDomUnmount } from '../overlay.test.mocks'; import { mount } from 'enzyme'; -import { i18nServiceMock } from '../../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { themeServiceMock } from '@kbn/core-theme-browser-mocks'; import { FlyoutService, OverlayFlyoutStart } from './flyout_service'; import { OverlayRef } from '../types'; diff --git a/src/core/public/overlays/flyout/flyout_service.tsx b/src/core/public/overlays/flyout/flyout_service.tsx index a7eed8a1751fd..701915113bb5a 100644 --- a/src/core/public/overlays/flyout/flyout_service.tsx +++ b/src/core/public/overlays/flyout/flyout_service.tsx @@ -13,7 +13,7 @@ import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import { Subject } from 'rxjs'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; -import { I18nStart } from '../../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { MountPoint } from '../../types'; import { OverlayRef } from '../types'; import { MountWrapper, CoreContextProvider } from '../../utils'; diff --git a/src/core/public/overlays/modal/__snapshots__/modal_service.test.tsx.snap b/src/core/public/overlays/modal/__snapshots__/modal_service.test.tsx.snap index a04210758053e..944cbf12ecaf9 100644 --- a/src/core/public/overlays/modal/__snapshots__/modal_service.test.tsx.snap +++ b/src/core/public/overlays/modal/__snapshots__/modal_service.test.tsx.snap @@ -89,7 +89,7 @@ Array [ ] `; -exports[`ModalService openConfirm() renders a mountpoint confirm message 2`] = `"
Modal content
"`; +exports[`ModalService openConfirm() renders a mountpoint confirm message 2`] = `"
Modal content
"`; exports[`ModalService openConfirm() renders a string confirm message 1`] = ` Array [ @@ -217,7 +217,7 @@ Array [ ] `; -exports[`ModalService openConfirm() renders a string confirm message 2`] = `"

Some message

"`; +exports[`ModalService openConfirm() renders a string confirm message 2`] = `"

Some message

"`; exports[`ModalService openConfirm() with a currently active confirm replaces the current confirm with the new one 1`] = ` Array [ diff --git a/src/core/public/overlays/modal/modal_service.test.tsx b/src/core/public/overlays/modal/modal_service.test.tsx index a95d61e4f46c2..bd4353c4e8982 100644 --- a/src/core/public/overlays/modal/modal_service.test.tsx +++ b/src/core/public/overlays/modal/modal_service.test.tsx @@ -10,7 +10,7 @@ import { mockReactDomRender, mockReactDomUnmount } from '../overlay.test.mocks'; import React from 'react'; import { mount } from 'enzyme'; -import { i18nServiceMock } from '../../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { themeServiceMock } from '@kbn/core-theme-browser-mocks'; import { ModalService, OverlayModalStart } from './modal_service'; import { mountReactNode } from '../../utils'; diff --git a/src/core/public/overlays/modal/modal_service.tsx b/src/core/public/overlays/modal/modal_service.tsx index 37c6e002e5904..0195fb2b5bf1f 100644 --- a/src/core/public/overlays/modal/modal_service.tsx +++ b/src/core/public/overlays/modal/modal_service.tsx @@ -14,7 +14,7 @@ import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import { Subject } from 'rxjs'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; -import { I18nStart } from '../../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { MountPoint } from '../../types'; import { OverlayRef } from '../types'; import { MountWrapper, CoreContextProvider } from '../../utils'; diff --git a/src/core/public/overlays/overlay_service.ts b/src/core/public/overlays/overlay_service.ts index 2a52aa323c480..35e839b0e175b 100644 --- a/src/core/public/overlays/overlay_service.ts +++ b/src/core/public/overlays/overlay_service.ts @@ -7,7 +7,7 @@ */ import type { ThemeServiceStart } from '@kbn/core-theme-browser'; -import { I18nStart } from '../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { IUiSettingsClient } from '../ui_settings'; import { OverlayBannersStart, OverlayBannersService } from './banners'; import { FlyoutService, OverlayFlyoutStart } from './flyout'; diff --git a/src/core/public/plugins/plugins_service.test.ts b/src/core/public/plugins/plugins_service.test.ts index 6e91392abde06..b3d0ab8f295a5 100644 --- a/src/core/public/plugins/plugins_service.test.ts +++ b/src/core/public/plugins/plugins_service.test.ts @@ -27,7 +27,7 @@ import { themeServiceMock } from '@kbn/core-theme-browser-mocks'; import { analyticsServiceMock } from '@kbn/core-analytics-browser-mocks'; import { notificationServiceMock } from '../notifications/notifications_service.mock'; import { applicationServiceMock } from '../application/application_service.mock'; -import { i18nServiceMock } from '../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { overlayServiceMock } from '../overlays/overlay_service.mock'; import { chromeServiceMock } from '../chrome/chrome_service.mock'; import { fatalErrorsServiceMock } from '../fatal_errors/fatal_errors_service.mock'; diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md index ddb6522c7afa8..d0a3bc2ad19cf 100644 --- a/src/core/public/public.api.md +++ b/src/core/public/public.api.md @@ -29,6 +29,7 @@ import { EventType } from '@kbn/analytics-client'; import { EventTypeOpts } from '@kbn/analytics-client'; import { History as History_2 } from 'history'; import { Href } from 'history'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import { IconType } from '@elastic/eui'; import { InjectedMetadataParams } from '@kbn/core-injected-metadata-browser-internal'; import type { InjectedMetadataSetup } from '@kbn/core-injected-metadata-browser'; @@ -445,6 +446,8 @@ export interface CoreStart { fatalErrors: FatalErrorsStart; // (undocumented) http: HttpStart; + // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver + // // (undocumented) i18n: I18nStart; // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "InjectedMetadataStart" @@ -688,12 +691,7 @@ export interface HttpSetup { // @public export type HttpStart = HttpSetup; -// @public -export interface I18nStart { - Context: ({ children }: { - children: React_2.ReactNode; - }) => JSX.Element; -} +export { I18nStart } // Warning: (ae-missing-release-tag) "IAnonymousPaths" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -1556,6 +1554,6 @@ export interface UserProvidedValues { // Warnings were encountered during analysis: // -// src/core/public/core_system.ts:186:21 - (ae-forgotten-export) The symbol "InternalApplicationStart" needs to be exported by the entry point index.d.ts +// src/core/public/core_system.ts:202:21 - (ae-forgotten-export) The symbol "InternalApplicationStart" needs to be exported by the entry point index.d.ts ``` diff --git a/src/core/public/rendering/rendering_service.test.tsx b/src/core/public/rendering/rendering_service.test.tsx index 3841cd98d33f7..13cfe0b29527e 100644 --- a/src/core/public/rendering/rendering_service.test.tsx +++ b/src/core/public/rendering/rendering_service.test.tsx @@ -14,7 +14,7 @@ import { applicationServiceMock } from '../application/application_service.mock' import { chromeServiceMock } from '../chrome/chrome_service.mock'; import { overlayServiceMock } from '../overlays/overlay_service.mock'; import { themeServiceMock } from '@kbn/core-theme-browser-mocks'; -import { i18nServiceMock } from '../i18n/i18n_service.mock'; +import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks'; import { BehaviorSubject } from 'rxjs'; describe('RenderingService#start', () => { diff --git a/src/core/public/rendering/rendering_service.tsx b/src/core/public/rendering/rendering_service.tsx index 53165b5ff0c42..48031db64897a 100644 --- a/src/core/public/rendering/rendering_service.tsx +++ b/src/core/public/rendering/rendering_service.tsx @@ -11,10 +11,10 @@ import ReactDOM from 'react-dom'; import { pairwise, startWith } from 'rxjs/operators'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; +import type { I18nStart } from '@kbn/core-i18n-browser'; import type { InternalChromeStart } from '../chrome'; import type { InternalApplicationStart } from '../application'; import type { OverlayStart } from '../overlays'; -import type { I18nStart } from '../i18n'; import { CoreContextProvider } from '../utils'; import { AppWrapper } from './app_containers'; diff --git a/src/core/public/utils/consts.ts b/src/core/public/utils/consts.ts new file mode 100644 index 0000000000000..8372eafec8147 --- /dev/null +++ b/src/core/public/utils/consts.ts @@ -0,0 +1,10 @@ +/* + * 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. + */ + +/** @internal */ +export const KBN_LOAD_MARKS = 'kbnLoad'; diff --git a/src/core/public/utils/core_context_provider.tsx b/src/core/public/utils/core_context_provider.tsx index 4d13bfb3a7d48..a400f8eae9916 100644 --- a/src/core/public/utils/core_context_provider.tsx +++ b/src/core/public/utils/core_context_provider.tsx @@ -9,7 +9,7 @@ import React, { FC } from 'react'; import type { ThemeServiceStart } from '@kbn/core-theme-browser'; import { CoreThemeProvider } from '@kbn/core-theme-browser-internal'; -import type { I18nStart } from '../i18n'; +import type { I18nStart } from '@kbn/core-i18n-browser'; interface CoreContextProviderProps { theme: ThemeServiceStart; diff --git a/src/core/public/utils/index.ts b/src/core/public/utils/index.ts index d28a8dcc37501..4fb9c50f715c6 100644 --- a/src/core/public/utils/index.ts +++ b/src/core/public/utils/index.ts @@ -9,3 +9,4 @@ export { Sha256 } from './crypto'; export { MountWrapper, mountReactNode } from './mount'; export { CoreContextProvider } from './core_context_provider'; +export { KBN_LOAD_MARKS } from './consts'; diff --git a/src/core/server/analytics/index.ts b/src/core/server/analytics/index.ts deleted file mode 100644 index 8a2f08d65bf9e..0000000000000 --- a/src/core/server/analytics/index.ts +++ /dev/null @@ -1,29 +0,0 @@ -/* - * 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 { AnalyticsService } from './analytics_service'; -export type { - AnalyticsServicePreboot, - AnalyticsServiceSetup, - AnalyticsServiceStart, -} from './analytics_service'; - -export type { - AnalyticsClient, - Event, - EventContext, - EventType, - EventTypeOpts, - IShipper, - ShipperClassConstructor, - OptInConfig, - ContextProviderOpts, - TelemetryCounter, -} from '@kbn/analytics-client'; - -export { TelemetryCounterType } from '@kbn/analytics-client'; diff --git a/src/core/server/bootstrap.ts b/src/core/server/bootstrap.ts index fd08d12e60416..851b698dbcc75 100644 --- a/src/core/server/bootstrap.ts +++ b/src/core/server/bootstrap.ts @@ -8,8 +8,8 @@ import chalk from 'chalk'; import { CliArgs, Env, RawConfigService } from '@kbn/config'; +import { CriticalError } from '@kbn/core-base-server-internal'; import { Root } from './root'; -import { CriticalError } from './errors'; interface BootstrapArgs { configs: string[]; diff --git a/src/core/server/config/index.ts b/src/core/server/config/index.ts deleted file mode 100644 index a873c593660af..0000000000000 --- a/src/core/server/config/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * 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 { coreDeprecationProvider } from './deprecation'; -export { ensureValidConfiguration } from './ensure_valid_configuration'; diff --git a/src/core/server/elasticsearch/elasticsearch_config.test.ts b/src/core/server/elasticsearch/elasticsearch_config.test.ts index 47453f1a80610..98fd88410adaf 100644 --- a/src/core/server/elasticsearch/elasticsearch_config.test.ts +++ b/src/core/server/elasticsearch/elasticsearch_config.test.ts @@ -13,7 +13,7 @@ import { } from './elasticsearch_config.test.mocks'; import { ElasticsearchConfig, config } from './elasticsearch_config'; -import { getDeprecationsFor } from '../config/test_utils'; +import { getDeprecationsFor } from '@kbn/core-config-server-internal'; const CONFIG_PATH = 'elasticsearch'; diff --git a/src/core/server/elasticsearch/elasticsearch_service.test.ts b/src/core/server/elasticsearch/elasticsearch_service.test.ts index 4e9b981fce75e..254c1c05a243d 100644 --- a/src/core/server/elasticsearch/elasticsearch_service.test.ts +++ b/src/core/server/elasticsearch/elasticsearch_service.test.ts @@ -29,6 +29,7 @@ import { Env } from '@kbn/config'; import { configServiceMock, getEnvOptions } from '@kbn/config-mocks'; import type { CoreContext } from '@kbn/core-base-server-internal'; import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; +import { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; import { httpServiceMock } from '../http/http_service.mock'; import { executionContextServiceMock } from '../execution_context/execution_context_service.mock'; import { configSchema, ElasticsearchConfig } from './elasticsearch_config'; @@ -37,7 +38,6 @@ import { elasticsearchClientMock } from './client/mocks'; import { duration } from 'moment'; import { isValidConnection as isValidConnectionMock } from './is_valid_connection'; import { pollEsNodesVersion as pollEsNodesVersionMocked } from './version_check/ensure_es_version'; -import { analyticsServiceMock } from '../analytics/analytics_service.mock'; const { pollEsNodesVersion: pollEsNodesVersionActual } = jest.requireActual( './version_check/ensure_es_version' diff --git a/src/core/server/elasticsearch/elasticsearch_service.ts b/src/core/server/elasticsearch/elasticsearch_service.ts index 90b616c0d439b..101ca5cea1bca 100644 --- a/src/core/server/elasticsearch/elasticsearch_service.ts +++ b/src/core/server/elasticsearch/elasticsearch_service.ts @@ -11,8 +11,8 @@ import { map, shareReplay, takeUntil } from 'rxjs/operators'; import type { Logger } from '@kbn/logging'; import type { CoreContext, CoreService } from '@kbn/core-base-server-internal'; +import type { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; import { registerAnalyticsContextProvider } from './register_analytics_context_provider'; -import { AnalyticsServiceSetup } from '../analytics'; import { ClusterClient, ElasticsearchClientConfig } from './client'; import { ElasticsearchConfig, ElasticsearchConfigType } from './elasticsearch_config'; diff --git a/src/core/server/elasticsearch/register_analytics_context_provider.test.ts b/src/core/server/elasticsearch/register_analytics_context_provider.test.ts index 4f09ea8677f44..b041586cf1903 100644 --- a/src/core/server/elasticsearch/register_analytics_context_provider.test.ts +++ b/src/core/server/elasticsearch/register_analytics_context_provider.test.ts @@ -7,8 +7,8 @@ */ import { firstValueFrom, of } from 'rxjs'; -import type { AnalyticsServiceSetup } from '../analytics'; -import { analyticsServiceMock } from '../analytics/analytics_service.mock'; +import { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; +import type { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; import { registerAnalyticsContextProvider } from './register_analytics_context_provider'; describe('registerAnalyticsContextProvider', () => { diff --git a/src/core/server/elasticsearch/register_analytics_context_provider.ts b/src/core/server/elasticsearch/register_analytics_context_provider.ts index cc4523c0d4eb5..9120d48fcb606 100644 --- a/src/core/server/elasticsearch/register_analytics_context_provider.ts +++ b/src/core/server/elasticsearch/register_analytics_context_provider.ts @@ -7,7 +7,7 @@ */ import type { Observable } from 'rxjs'; -import type { AnalyticsServiceSetup } from '../analytics'; +import type { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; import type { ClusterInfo } from './get_cluster_info'; /** diff --git a/src/core/server/environment/environment_service.test.ts b/src/core/server/environment/environment_service.test.ts index 563db4e91918f..d13f78609ed8d 100644 --- a/src/core/server/environment/environment_service.test.ts +++ b/src/core/server/environment/environment_service.test.ts @@ -9,16 +9,17 @@ import { BehaviorSubject } from 'rxjs'; import type { CoreContext } from '@kbn/core-base-server-internal'; +import type { AnalyticsServicePreboot } from '@kbn/core-analytics-server'; + import { EnvironmentService } from './environment_service'; import { resolveInstanceUuid } from './resolve_uuid'; import { createDataFolder } from './create_data_folder'; import { writePidFile } from './write_pid_file'; -import type { AnalyticsServicePreboot } from '../analytics'; import { configServiceMock } from '@kbn/config-mocks'; import { mockCoreContext } from '@kbn/core-base-server-mocks'; import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; -import { analyticsServiceMock } from '../analytics/analytics_service.mock'; +import { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; jest.mock('./resolve_uuid', () => ({ resolveInstanceUuid: jest.fn().mockResolvedValue('SOME_UUID'), diff --git a/src/core/server/environment/environment_service.ts b/src/core/server/environment/environment_service.ts index 9fcf54c7bc1c2..17dd296a81b10 100644 --- a/src/core/server/environment/environment_service.ts +++ b/src/core/server/environment/environment_service.ts @@ -11,7 +11,7 @@ import { PathConfigType, config as pathConfigDef } from '@kbn/utils'; import type { Logger } from '@kbn/logging'; import type { IConfigService } from '@kbn/config'; import type { CoreContext } from '@kbn/core-base-server-internal'; -import type { AnalyticsServicePreboot } from '../analytics'; +import type { AnalyticsServicePreboot } from '@kbn/core-analytics-server'; import { HttpConfigType, config as httpConfigDef } from '../http'; import { PidConfigType, config as pidConfigDef } from './pid_config'; import { resolveInstanceUuid } from './resolve_uuid'; diff --git a/src/core/server/index.ts b/src/core/server/index.ts index 252d23bb5c444..6266fbd3fd64a 100644 --- a/src/core/server/index.ts +++ b/src/core/server/index.ts @@ -33,6 +33,11 @@ import { Type } from '@kbn/config-schema'; import type { DocLinksServiceStart, DocLinksServiceSetup } from '@kbn/core-doc-links-server'; import type { AppenderConfigType, LoggingServiceSetup } from '@kbn/core-logging-server'; import { appendersSchema } from '@kbn/core-logging-server-internal'; +import type { + AnalyticsServiceSetup, + AnalyticsServiceStart, + AnalyticsServicePreboot, +} from '@kbn/core-analytics-server'; import { ElasticsearchServiceSetup, configSchema as elasticsearchConfigSchema, @@ -85,11 +90,6 @@ export type { }; import type { ExecutionContextSetup, ExecutionContextStart } from './execution_context'; -import type { - AnalyticsServicePreboot, - AnalyticsServiceSetup, - AnalyticsServiceStart, -} from './analytics'; export type { IExecutionContextContainer, KibanaExecutionContext } from './execution_context'; @@ -453,9 +453,6 @@ export type { export type { DocLinksServiceStart, DocLinksServiceSetup } from '@kbn/core-doc-links-server'; export type { - AnalyticsServiceSetup, - AnalyticsServicePreboot, - AnalyticsServiceStart, AnalyticsClient, Event, EventContext, @@ -466,8 +463,13 @@ export type { OptInConfig, ShipperClassConstructor, TelemetryCounter, -} from './analytics'; -export { TelemetryCounterType } from './analytics'; +} from '@kbn/analytics-client'; +export { TelemetryCounterType } from '@kbn/analytics-client'; +export type { + AnalyticsServiceSetup, + AnalyticsServicePreboot, + AnalyticsServiceStart, +} from '@kbn/core-analytics-server'; /** @public **/ export interface RequestHandlerContextBase { diff --git a/src/core/server/internal_types.ts b/src/core/server/internal_types.ts index 99e85406c9e76..934809f6f0eb6 100644 --- a/src/core/server/internal_types.ts +++ b/src/core/server/internal_types.ts @@ -11,6 +11,11 @@ import { InternalLoggingServicePreboot, InternalLoggingServiceSetup, } from '@kbn/core-logging-server-internal'; +import type { + AnalyticsServicePreboot, + AnalyticsServiceSetup, + AnalyticsServiceStart, +} from '@kbn/core-analytics-server'; import { CapabilitiesSetup, CapabilitiesStart } from './capabilities'; import { InternalContextPreboot, ContextSetup } from './context'; import { @@ -45,11 +50,6 @@ import type { InternalExecutionContextStart, } from './execution_context'; import { InternalPrebootServicePreboot } from './preboot'; -import type { - AnalyticsServicePreboot, - AnalyticsServiceSetup, - AnalyticsServiceStart, -} from './analytics'; /** @internal */ export interface InternalCorePreboot { diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts index 2796e5a5742d1..a39efc69bd619 100644 --- a/src/core/server/mocks.ts +++ b/src/core/server/mocks.ts @@ -13,6 +13,7 @@ import { isPromise } from '@kbn/std'; import type { MockedKeys } from '@kbn/utility-types-jest'; import { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks'; import { loggingSystemMock, loggingServiceMock } from '@kbn/core-logging-server-mocks'; +import { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; import type { PluginInitializerContext, CoreSetup, @@ -39,7 +40,6 @@ import { i18nServiceMock } from './i18n/i18n_service.mock'; import { deprecationsServiceMock } from './deprecations/deprecations_service.mock'; import { executionContextServiceMock } from './execution_context/execution_context_service.mock'; import { prebootServiceMock } from './preboot/preboot_service.mock'; -import { analyticsServiceMock } from './analytics/analytics_service.mock'; export { configServiceMock, configDeprecationsMock } from '@kbn/config-mocks'; export { loggingSystemMock } from '@kbn/core-logging-server-mocks'; @@ -64,7 +64,7 @@ export { i18nServiceMock } from './i18n/i18n_service.mock'; export { deprecationsServiceMock } from './deprecations/deprecations_service.mock'; export { executionContextServiceMock } from './execution_context/execution_context_service.mock'; export { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks'; -export { analyticsServiceMock } from './analytics/analytics_service.mock'; +export { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; export type { ElasticsearchClientMock, diff --git a/src/core/server/rendering/bootstrap/__snapshots__/render_template.test.ts.snap b/src/core/server/rendering/bootstrap/__snapshots__/render_template.test.ts.snap index 83aacda2b599a..f7e28eebd1a61 100644 --- a/src/core/server/rendering/bootstrap/__snapshots__/render_template.test.ts.snap +++ b/src/core/server/rendering/bootstrap/__snapshots__/render_template.test.ts.snap @@ -104,6 +104,10 @@ if (window.__kbnStrictCsp__ && window.__kbnCspNotEnforced__) { }); } + performance.mark('kbnLoad', { + detail: 'load_started', + }) + load([ '/js-1','/js-2' ], function () { diff --git a/src/core/server/rendering/bootstrap/render_template.ts b/src/core/server/rendering/bootstrap/render_template.ts index 14127017b1c0f..996aacd5e3ede 100644 --- a/src/core/server/rendering/bootstrap/render_template.ts +++ b/src/core/server/rendering/bootstrap/render_template.ts @@ -120,6 +120,10 @@ if (window.__kbnStrictCsp__ && window.__kbnCspNotEnforced__) { }); } + performance.mark('kbnLoad', { + detail: 'load_started', + }) + load([ ${jsDependencyPaths.map((path) => `'${path}'`).join(',')} ], function () { diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index d3862e494fb59..6a85c1dff4bd1 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -8,6 +8,9 @@ import { AddConfigDeprecation } from '@kbn/config'; import { AnalyticsClient } from '@kbn/analytics-client'; +import { AnalyticsServicePreboot } from '@kbn/core-analytics-server'; +import { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; +import { AnalyticsServiceStart } from '@kbn/core-analytics-server'; import apm from 'elastic-apm-node'; import { AppenderConfigType } from '@kbn/core-logging-server'; import { AwaitedProperties } from '@kbn/utility-types'; @@ -82,20 +85,11 @@ export { AddConfigDeprecation } export { AnalyticsClient } -// Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver -// -// @public -export type AnalyticsServicePreboot = Omit; +export { AnalyticsServicePreboot } -// Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver -// -// @public -export type AnalyticsServiceSetup = Omit; +export { AnalyticsServiceSetup } -// Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver -// -// @public -export type AnalyticsServiceStart = Pick; +export { AnalyticsServiceStart } // @public export const APP_WRAPPER_CLASS = "kbnAppWrapper"; @@ -438,6 +432,8 @@ export type CoreIncrementUsageCounter = (params: CoreIncrementCounterParams) => // @public export interface CorePreboot { + // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver + // // (undocumented) analytics: AnalyticsServicePreboot; // (undocumented) @@ -495,6 +491,8 @@ export interface CoreServicesUsageData { // @public export interface CoreSetup { + // Warning: (ae-unresolved-link) The @link reference could not be resolved: This type of declaration is not supported yet by the resolver + // // (undocumented) analytics: AnalyticsServiceSetup; // (undocumented) @@ -537,6 +535,8 @@ export interface CoreSetup ({ })); export const mockEnsureValidConfiguration = jest.fn(); -jest.doMock('./config/ensure_valid_configuration', () => ({ +jest.doMock('@kbn/core-config-server-internal', () => ({ ensureValidConfiguration: mockEnsureValidConfiguration, })); diff --git a/src/core/server/server.ts b/src/core/server/server.ts index cf428a56844ac..7beb8ff86150b 100644 --- a/src/core/server/server.ts +++ b/src/core/server/server.ts @@ -17,7 +17,12 @@ import { ILoggingSystem, config as loggingConfig, } from '@kbn/core-logging-server-internal'; -import { coreDeprecationProvider, ensureValidConfiguration } from './config'; +import { + coreDeprecationProvider, + ensureValidConfiguration, +} from '@kbn/core-config-server-internal'; +import { AnalyticsService } from '@kbn/core-analytics-server-internal'; +import type { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; import { CoreApp } from './core_app'; import { I18nService } from './i18n'; import { ElasticsearchService } from './elasticsearch'; @@ -51,7 +56,6 @@ import { config as executionContextConfig } from './execution_context'; import { PrebootCoreRouteHandlerContext } from './preboot_core_route_handler_context'; import { PrebootService } from './preboot'; import { DiscoveredPlugins } from './plugins'; -import { AnalyticsService, AnalyticsServiceSetup } from './analytics'; const coreId = Symbol('core'); const rootConfigPath = ''; diff --git a/src/core/server/status/status_service.test.ts b/src/core/server/status/status_service.test.ts index c58705ab60403..e6904464edb09 100644 --- a/src/core/server/status/status_service.test.ts +++ b/src/core/server/status/status_service.test.ts @@ -24,7 +24,7 @@ import { mockRouter, RouterMock } from '../http/router/router.mock'; import { metricsServiceMock } from '../metrics/metrics_service.mock'; import { configServiceMock } from '@kbn/config-mocks'; import { coreUsageDataServiceMock } from '../core_usage_data/core_usage_data_service.mock'; -import { analyticsServiceMock } from '../analytics/analytics_service.mock'; +import { analyticsServiceMock } from '@kbn/core-analytics-server-mocks'; import { AnalyticsServiceSetup } from '..'; expect.addSnapshotSerializer(ServiceStatusLevelSnapshotSerializer); diff --git a/src/core/server/status/status_service.ts b/src/core/server/status/status_service.ts index 65ddfc799facd..7288718ce2765 100644 --- a/src/core/server/status/status_service.ts +++ b/src/core/server/status/status_service.ts @@ -22,7 +22,7 @@ import type { RootSchema } from '@kbn/analytics-client'; import { Logger, LogMeta } from '@kbn/logging'; import type { CoreContext, CoreService } from '@kbn/core-base-server-internal'; import type { PluginName } from '@kbn/core-base-common'; -import { AnalyticsServiceSetup } from '../analytics'; +import type { AnalyticsServiceSetup } from '@kbn/core-analytics-server'; import { InternalElasticsearchServiceSetup } from '../elasticsearch'; import { InternalHttpServiceSetup } from '../http'; import { InternalSavedObjectsServiceSetup } from '../saved_objects'; diff --git a/src/core/server/test_utils.ts b/src/core/server/test_utils.ts index cf18defb0a960..4e2f8855209ff 100644 --- a/src/core/server/test_utils.ts +++ b/src/core/server/test_utils.ts @@ -9,4 +9,7 @@ export { createHttpServer } from './http/test_utils'; export { ServiceStatusLevelSnapshotSerializer } from './status/test_utils'; export { setupServer } from './saved_objects/routes/test_utils'; -export { getDeprecationsFor, getDeprecationsForGlobalSettings } from './config/test_utils'; +export { + getDeprecationsFor, + getDeprecationsForGlobalSettings, +} from '@kbn/core-config-server-internal'; diff --git a/src/dev/license_checker/config.ts b/src/dev/license_checker/config.ts index dd6ac0e4cab49..d011ce465305c 100644 --- a/src/dev/license_checker/config.ts +++ b/src/dev/license_checker/config.ts @@ -77,6 +77,6 @@ export const LICENSE_OVERRIDES = { 'jsts@1.6.2': ['Eclipse Distribution License - v 1.0'], // cf. https://github.com/bjornharrtell/jsts '@mapbox/jsonlint-lines-primitives@2.0.2': ['MIT'], // license in readme https://github.com/tmcw/jsonlint '@elastic/ems-client@8.3.3': ['Elastic License 2.0'], - '@elastic/eui@58.0.0': ['SSPL-1.0 OR Elastic License 2.0'], + '@elastic/eui@59.0.1': ['SSPL-1.0 OR Elastic License 2.0'], 'language-subtag-registry@0.3.21': ['CC-BY-4.0'], // retired ODC‑By license https://github.com/mattcg/language-subtag-registry }; diff --git a/src/dev/run_check_published_api_changes.ts b/src/dev/run_check_published_api_changes.ts deleted file mode 100644 index 7ca27e51dd4b5..0000000000000 --- a/src/dev/run_check_published_api_changes.ts +++ /dev/null @@ -1,288 +0,0 @@ -/* - * 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. - */ - -import { ToolingLog } from '@kbn/tooling-log'; -import { getTimeReporter } from '@kbn/ci-stats-reporter'; -import { - Extractor, - IConfigFile, - ExtractorLogLevel, - ExtractorConfig, - ExtractorResult, - ExtractorMessage, -} from '@microsoft/api-extractor'; -import chalk from 'chalk'; -import dedent from 'dedent'; -import execa from 'execa'; -import fs from 'fs'; -import path from 'path'; -import getopts from 'getopts'; - -const log = new ToolingLog({ - level: 'info', - writeTo: process.stdout, -}); - -const runStartTime = Date.now(); -const reportTime = getTimeReporter(log, 'scripts/check_published_api_changes'); - -/* - * Step 1: execute build:types - * This users tsconfig.types.json to generate types in `target/types` - * Step 2: run Api Extractor to detect API changes - * Step 3: generate new docs if needed - */ - -const getReportFileName = (folder: string) => { - switch (true) { - case folder.includes('public'): - return 'public'; - case folder.includes('server'): - return 'server'; - case folder.includes('common'): - return 'common'; - default: - throw new Error( - `folder "${folder}" expected to include one of ["public", "server", "common"]` - ); - } -}; - -const apiExtractorConfig = (folder: string): ExtractorConfig => { - const fname = getReportFileName(folder); - const config: IConfigFile = { - newlineKind: 'lf', - compiler: { - tsconfigFilePath: '/tsconfig.json', - }, - projectFolder: path.resolve('./'), - mainEntryPointFilePath: `target/types/${folder}/index.d.ts`, - apiReport: { - enabled: true, - reportFileName: `${fname}.api.md`, - reportFolder: `/src/${folder}/`, - reportTempFolder: `/build/${folder}/`, - }, - docModel: { - enabled: true, - apiJsonFilePath: `./build/${folder}/${fname}.api.json`, - }, - tsdocMetadata: { - enabled: false, - }, - messages: { - extractorMessageReporting: { - default: { - logLevel: 'warning' as ExtractorLogLevel.Warning, - addToApiReportFile: true, - }, - 'ae-internal-missing-underscore': { - logLevel: 'none' as ExtractorLogLevel.None, - addToApiReportFile: false, - }, - }, - }, - }; - const cfg = ExtractorConfig.prepare({ - configObject: config, - configObjectFullPath: undefined, - packageJsonFullPath: path.resolve('package.json'), - }); - - return cfg; -}; - -const runBuildTypes = async () => { - await execa('yarn', ['run', 'build:types']); -}; - -const runApiDocumenter = async (folder: string) => { - const sourceFolder = `./build/${folder}`; - const targetFolder = `./docs/development/${folder}`; - log.info(`Generating docs from ${sourceFolder} into ${targetFolder}...`); - await execa('api-documenter', ['generate', '-i', sourceFolder, '-o', targetFolder], { - preferLocal: true, - }); -}; - -const renameExtractedApiPackageName = async (folder: string) => { - const fname = getReportFileName(folder); - const jsonApiFile = `build/${folder}/${fname}.api.json`; - log.info(`Updating ${jsonApiFile}...`); - const json = JSON.parse(fs.readFileSync(jsonApiFile).toString()); - json.name = json.canonicalReference = `kibana-plugin-${folder.replace(/\//g, '-')}`; - fs.writeFileSync(jsonApiFile, JSON.stringify(json, null, 2)); -}; - -/** - * Runs api-extractor with a custom logger in order to extract results from the process - * - */ -const runApiExtractor = (folder: string, acceptChanges: boolean = false): ExtractorResult => { - const config = apiExtractorConfig(folder); - const options = { - // Indicates that API Extractor is running as part of a local build, - // e.g. on developer's machine. For example, if the *.api.md output file - // has differences, it will be automatically overwritten for a - // local build, whereas this should report an error for a production build. - localBuild: acceptChanges, - messageCallback: (message: ExtractorMessage) => { - if (message.messageId === 'console-api-report-not-copied') { - // ConsoleMessageId.ApiReportNotCopied - log.warning(`You have changed the signature of the ${folder} public API`); - log.warning( - 'To accept these changes run `node scripts/check_published_api_changes.js --accept` and then:\n' + - "\t 1. Commit the updated documentation and API review file '" + - config.reportFilePath + - "' \n" + - "\t 2. Describe the change in your PR including whether it's a major, minor or patch" - ); - message.handled = true; - } else if (message.messageId === 'console-api-report-copied') { - // ConsoleMessageId.ApiReportCopied - log.warning(`You have changed the signature of the ${folder} public API`); - log.warning( - "Please commit the updated API documentation and the API review file: '" + - config.reportFilePath - ); - message.handled = true; - } else if (message.messageId === 'console-api-report-unchanged') { - // ConsoleMessageId.ApiReportUnchanged - log.info(`${folder} API: no changes detected ✔`); - message.handled = true; - } - }, - }; - - return Extractor.invoke(config, options); -}; - -interface Options { - accept: boolean; - docs: boolean; - help: boolean; - filter: string; -} - -async function run(folder: string, { opts }: { opts: Options }): Promise { - log.info(`${folder} API: checking for changes in API signature...`); - - const { apiReportChanged, succeeded } = runApiExtractor(folder, opts.accept); - - // If we're not accepting changes and there's a failure, exit. - if (!opts.accept && !succeeded) { - return false; - } - - // Attempt to generate docs even if api-extractor didn't succeed - if ((opts.accept && apiReportChanged) || opts.docs) { - try { - await renameExtractedApiPackageName(folder); - await runApiDocumenter(folder); - } catch (e) { - log.error(e); - return false; - } - - log.info(`${folder} API: updated documentation ✔`); - } - - // If the api signature changed or any errors or warnings occured, exit with an error - // NOTE: Because of https://github.com/Microsoft/web-build-tools/issues/1258 - // api-extractor will not return `succeeded: false` when the API changes. - return !apiReportChanged && succeeded; -} - -(async () => { - const extraFlags: string[] = []; - const opts = getopts(process.argv.slice(2), { - boolean: ['accept', 'docs', 'help'], - string: ['filter'], - default: { - project: undefined, - }, - unknown(name) { - extraFlags.push(name); - return false; - }, - }) as any as Options; - - if (extraFlags.length > 0) { - for (const flag of extraFlags) { - log.error(`Unknown flag: ${flag}`); - } - - opts.help = true; - } - - const folders = ['core/public', 'core/server']; - - if (opts.help) { - process.stdout.write( - dedent(chalk` - {dim usage:} node scripts/check_published_api_changes [...options] - - Checks for any changes to the Kibana shared API - - Examples: - - {dim # Checks for any changes to the Kibana shared API} - {dim $} node scripts/check_published_api_changes - - {dim # Checks for any changes to the Kibana shared API and updates the documentation} - {dim $} node scripts/check_published_api_changes --docs - - {dim # Checks for and automatically accepts and updates documentation for any changes to the Kibana shared API} - {dim $} node scripts/check_published_api_changes --accept - - {dim # Only checks the core/public directory} - {dim $} node scripts/check_published_api_changes --filter=core/public - - Options: - --accept {dim Accepts all changes by updating the API Review files and documentation} - --docs {dim Updates the API documentation} - --filter {dim RegExp that folder names must match, folders: [${folders.join(', ')}]} - --help {dim Show this message} - `) - ); - process.stdout.write('\n'); - return !(extraFlags.length > 0); - } - - log.info('Building types for api extractor...'); - await runBuildTypes(); - log.info('Types for api extractor has been built'); - - const filteredFolders = folders.filter((folder) => - opts.filter.length ? folder.match(opts.filter) : true - ); - const results = []; - for (const folder of filteredFolders) { - results.push(await run(folder, { opts })); - } - - if (results.includes(false)) { - reportTime(runStartTime, 'error', { - success: false, - ...opts, - }); - process.exitCode = 1; - } else { - reportTime(runStartTime, 'total', { - success: true, - ...opts, - }); - } -})().catch((e) => { - reportTime(runStartTime, 'error', { - success: false, - error: e.message, - }); - log.error(e); - process.exitCode = 1; -}); diff --git a/src/plugins/charts/public/static/components/common_chart_styles.ts b/src/plugins/charts/public/static/components/common_chart_styles.ts index 3050b5f4a74ba..f2c62dfdff927 100644 --- a/src/plugins/charts/public/static/components/common_chart_styles.ts +++ b/src/plugins/charts/public/static/components/common_chart_styles.ts @@ -17,9 +17,9 @@ export const useCommonChartStyles = () => { const subdued = useMemo( () => css` - fill: ${euiTheme.colors.subdued}; + fill: ${euiTheme.colors.subduedText}; `, - [euiTheme.colors.subdued] + [euiTheme.colors.subduedText] ); const accent = css` diff --git a/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap b/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap index 88ca645d44057..2234dcdba4dd9 100644 --- a/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap +++ b/src/plugins/dashboard/public/application/embeddable/empty_screen/__snapshots__/dashboard_empty_screen.test.tsx.snap @@ -21,15 +21,11 @@ exports[`DashboardEmptyScreen renders correctly with edit mode 1`] = ` class="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />
-
- - Create content that tells a story about your data. - -
+ + Create content that tells a story about your data. +
`; @@ -44,7 +40,7 @@ exports[`DashboardEmptyScreen renders correctly with readonly mode 1`] = ` class="euiPageBody euiPageBody--borderRadiusNone" >

-
- You need additional privileges to edit this dashboard. -
+ You need additional privileges to edit this dashboard.
@@ -89,7 +81,7 @@ exports[`DashboardEmptyScreen renders correctly with view mode 1`] = ` class="euiPageBody euiPageBody--borderRadiusNone" >

-
-

- Click edit in the menu bar above to start adding panels. -

-
+

+ Click edit in the menu bar above to start adding panels. +

diff --git a/src/plugins/data/public/search/session/sessions_mgmt/components/status.test.tsx b/src/plugins/data/public/search/session/sessions_mgmt/components/status.test.tsx index 5cee810997393..0dbd14591e10e 100644 --- a/src/plugins/data/public/search/session/sessions_mgmt/components/status.test.tsx +++ b/src/plugins/data/public/search/session/sessions_mgmt/components/status.test.tsx @@ -65,9 +65,11 @@ describe('Background Search Session management status labels', () => { ); - const label = statusIndicator.find( - `.euiText[data-test-subj="sessionManagementStatusLabel"][data-test-status="in_progress"]` - ); + const label = statusIndicator + .find( + `.euiText[data-test-subj="sessionManagementStatusLabel"][data-test-status="in_progress"]` + ) + .last(); expect(label.text()).toMatchInlineSnapshot(`"In progress"`); }); diff --git a/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.test.tsx b/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.test.tsx index 39f20fec462a2..690713ac9232f 100644 --- a/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.test.tsx +++ b/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.test.tsx @@ -262,7 +262,7 @@ describe('Search Sessions Management table column factory', () => { const statusLine = mount(status.render!(mockSession.status, mockSession) as ReactElement); expect( - statusLine.find('.euiText[data-test-subj="sessionManagementStatusTooltip"]').text() + statusLine.find('.euiText[data-test-subj="sessionManagementStatusTooltip"]').last().text() ).toMatchInlineSnapshot(`"In progress"`); }); diff --git a/src/plugins/data/public/utils/table_inspector_view/components/__snapshots__/data_view.test.tsx.snap b/src/plugins/data/public/utils/table_inspector_view/components/__snapshots__/data_view.test.tsx.snap index 0169532453a64..cc03f542b01f3 100644 --- a/src/plugins/data/public/utils/table_inspector_view/components/__snapshots__/data_view.test.tsx.snap +++ b/src/plugins/data/public/utils/table_inspector_view/components/__snapshots__/data_view.test.tsx.snap @@ -2,7 +2,7 @@ exports[`Inspector Data View component should render empty state 1`] = `
No data available - +
-
-
-

- The element did not provide any data. -

-
- +

+ The element did not provide any data. +

+
@@ -463,7 +459,7 @@ Array [ class="euiFlexItem" >

diff --git a/src/plugins/data_view_management/public/components/field_editor/components/scripting_call_outs/__snapshots__/warning_call_out.test.tsx.snap b/src/plugins/data_view_management/public/components/field_editor/components/scripting_call_outs/__snapshots__/warning_call_out.test.tsx.snap index 958025649b107..9605634aa1a43 100644 --- a/src/plugins/data_view_management/public/components/field_editor/components/scripting_call_outs/__snapshots__/warning_call_out.test.tsx.snap +++ b/src/plugins/data_view_management/public/components/field_editor/components/scripting_call_outs/__snapshots__/warning_call_out.test.tsx.snap @@ -3,7 +3,7 @@ exports[`ScriptingWarningCallOut should render normally 1`] = ` Array [

@@ -33,7 +33,7 @@ Array [ class="euiSpacer euiSpacer--m css-jv9za2-euiSpacer-m" />,

-
-

- - For greater flexibility and Painless script support, use - - . - -

-
+

+ + For greater flexibility and Painless script support, use + + . + +

, diff --git a/src/plugins/data_views/README.mdx b/src/plugins/data_views/README.mdx index f4aa08da8b8ab..2d7bf08d78586 100644 --- a/src/plugins/data_views/README.mdx +++ b/src/plugins/data_views/README.mdx @@ -20,5 +20,5 @@ and field lists across the various Kibana apps. Its typically used in conjunctio **hasData:** A standardized way to check the empty state for indices and data views. - `hasESData: () => Promise; // Check to see if ES data exists` -- `hasDataView: () => Promise; // Check to see if any data view exists (primitive or user created)` -- `hasUserDataView: () => Promise; // Check to see if user created data views exists` +- `hasDataView: () => Promise; // Check to see if any data view exists (managed or user created)` +- `hasUserDataView: () => Promise; // Check to see if user created data views exists` diff --git a/src/plugins/discover/public/__fixtures__/fake_row.js b/src/plugins/discover/public/__fixtures__/fake_row.js deleted file mode 100644 index 8cba3d85a69c3..0000000000000 --- a/src/plugins/discover/public/__fixtures__/fake_row.js +++ /dev/null @@ -1,25 +0,0 @@ -/* - * 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. - */ - -const longString = Array(200).join('_'); - -export function getFakeRowVals(type, id, mapping) { - return mapping.reduce((collector, field) => { - collector[field.name] = `${field.name}_${type}_${id}_${longString}`; - return collector; - }, {}); -} - -export function getFakeRow(id, mapping) { - return { - _id: id, - _index: 'test', - _source: getFakeRowVals('original', id, mapping), - sort: [id], - }; -} diff --git a/src/plugins/discover/public/__fixtures__/real_hits.js b/src/plugins/discover/public/__fixtures__/real_hits.js deleted file mode 100644 index 0286d036de090..0000000000000 --- a/src/plugins/discover/public/__fixtures__/real_hits.js +++ /dev/null @@ -1,232 +0,0 @@ -/* - * 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. - */ - -/* - Extensions: - gif: 5 - html: 8 - php: 5 (thus 5 with phpmemory fields) - png: 2 - - _type: - apache: 18 - nginx: 2 - - Bytes (all unique except): - 374: 2 - - All have the same index, ids are unique -*/ - -export default [ - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '61', - _score: 1, - _source: { - extension: 'html', - bytes: 360.20000000000005, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '388', - _score: 1, - _source: { - extension: 'gif', - bytes: 5848.700000000001, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '403', - _score: 1, - _source: { - extension: 'png', - bytes: 841.6, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '415', - _score: 1, - _source: { - extension: 'html', - bytes: 1626.4, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '460', - _score: 1, - _source: { - extension: 'php', - bytes: 2070.6, - phpmemory: 276080, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '496', - _score: 1, - _source: { - extension: 'gif', - bytes: 8421.6, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '511', - _score: 1, - _source: { - extension: 'html', - bytes: 994.8000000000001, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '701', - _score: 1, - _source: { - extension: 'html', - bytes: 374, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '838', - _score: 1, - _source: { - extension: 'php', - bytes: 506.09999999999997, - phpmemory: 67480, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '890', - _score: 1, - _source: { - extension: 'php', - bytes: 506.09999999999997, - phpmemory: 67480, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'nginx', - _id: '927', - _score: 1, - _source: { - extension: 'php', - bytes: 2591.1, - phpmemory: 345480, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1034', - _score: 1, - _source: { - extension: 'html', - bytes: 1450, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1142', - _score: 1, - _source: { - extension: 'php', - bytes: 1803.8999999999999, - phpmemory: 240520, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1180', - _score: 1, - _source: { - extension: 'html', - bytes: 1626.4, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'nginx', - _id: '1224', - _score: 1, - _source: { - extension: 'gif', - bytes: 10617.2, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1243', - _score: 1, - _source: { - extension: 'gif', - bytes: 10961.5, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1510', - _score: 1, - _source: { - extension: 'html', - bytes: 382.8, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1628', - _score: 1, - _source: { - extension: 'html', - bytes: 374, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1729', - _score: 1, - _source: { - extension: 'png', - bytes: 3059.2000000000003, - }, - }, - { - _index: 'logstash-2014.09.09', - _type: 'apache', - _id: '1945', - _score: 1, - _source: { - extension: 'gif', - bytes: 10617.2, - }, - }, -]; diff --git a/src/plugins/discover/public/__fixtures__/real_hits.ts b/src/plugins/discover/public/__fixtures__/real_hits.ts new file mode 100644 index 0000000000000..96d084a977bd4 --- /dev/null +++ b/src/plugins/discover/public/__fixtures__/real_hits.ts @@ -0,0 +1,219 @@ +/* + * 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. + */ +import type { DataView } from '@kbn/data-views-plugin/common'; +import { cloneDeep } from 'lodash'; +import { buildDataTableRecord } from '../utils/build_data_record'; +import type { EsHitRecord } from '../types'; +/* + Extensions: + gif: 5 + html: 8 + php: 5 (thus 5 with phpmemory fields) + png: 2 + + _type: + apache: 18 + nginx: 2 + + Bytes (all unique except): + 374: 2 + + All have the same index, ids are unique +*/ + +export const realHits: EsHitRecord[] = [ + { + _index: 'logstash-2014.09.09', + _id: '61', + _score: 1, + _source: { + extension: 'html', + bytes: 360.20000000000005, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '388', + _score: 1, + _source: { + extension: 'gif', + bytes: 5848.700000000001, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '403', + _score: 1, + _source: { + extension: 'png', + bytes: 841.6, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '415', + _score: 1, + _source: { + extension: 'html', + bytes: 1626.4, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '460', + _score: 1, + _source: { + extension: 'php', + bytes: 2070.6, + phpmemory: 276080, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '496', + _score: 1, + _source: { + extension: 'gif', + bytes: 8421.6, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '511', + _score: 1, + _source: { + extension: 'html', + bytes: 994.8000000000001, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '701', + _score: 1, + _source: { + extension: 'html', + bytes: 374, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '838', + _score: 1, + _source: { + extension: 'php', + bytes: 506.09999999999997, + phpmemory: 67480, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '890', + _score: 1, + _source: { + extension: 'php', + bytes: 506.09999999999997, + phpmemory: 67480, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '927', + _score: 1, + _source: { + extension: 'php', + bytes: 2591.1, + phpmemory: 345480, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1034', + _score: 1, + _source: { + extension: 'html', + bytes: 1450, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1142', + _score: 1, + _source: { + extension: 'php', + bytes: 1803.8999999999999, + phpmemory: 240520, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1180', + _score: 1, + _source: { + extension: 'html', + bytes: 1626.4, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1224', + _score: 1, + _source: { + extension: 'gif', + bytes: 10617.2, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1243', + _score: 1, + _source: { + extension: 'gif', + bytes: 10961.5, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1510', + _score: 1, + _source: { + extension: 'html', + bytes: 382.8, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1628', + _score: 1, + _source: { + extension: 'html', + bytes: 374, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1729', + _score: 1, + _source: { + extension: 'png', + bytes: 3059.2000000000003, + }, + }, + { + _index: 'logstash-2014.09.09', + _id: '1945', + _score: 1, + _source: { + extension: 'gif', + bytes: 10617.2, + }, + }, +]; + +export function getDataTableRecords(dataView: DataView) { + return cloneDeep(realHits).map((hit: EsHitRecord) => buildDataTableRecord(hit, dataView)); +} diff --git a/src/plugins/discover/public/__mocks__/grid_context.ts b/src/plugins/discover/public/__mocks__/grid_context.ts index 3f760bc4a4258..7e35aaf42204c 100644 --- a/src/plugins/discover/public/__mocks__/grid_context.ts +++ b/src/plugins/discover/public/__mocks__/grid_context.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -import { flattenHit } from '@kbn/data-plugin/common'; import type { DataView } from '@kbn/data-views-plugin/public'; import { indexPatternMock } from './index_pattern'; import { dataViewComplexMock } from './data_view_complex'; @@ -15,18 +14,18 @@ import { esHitsComplex } from './es_hits_complex'; import { discoverServiceMock } from './services'; import { GridContext } from '../components/discover_grid/discover_grid_context'; import { convertValueToString } from '../utils/convert_value_to_string'; -import type { ElasticSearchHit } from '../types'; +import { buildDataTableRecord } from '../utils/build_data_record'; +import { EsHitRecord } from '../types'; -const buildGridContext = (dataView: DataView, rows: ElasticSearchHit[]): GridContext => { - const rowsFlattened = rows.map((hit) => - flattenHit(hit, dataView, { includeIgnoredValues: true }) - ); +const buildGridContext = (dataView: DataView, rows: EsHitRecord[]): GridContext => { + const usedRows = rows.map((row) => { + return buildDataTableRecord(row, dataView); + }); return { expanded: undefined, setExpanded: jest.fn(), - rows, - rowsFlattened, + rows: usedRows, onFilter: jest.fn(), indexPattern: dataView, isDarkMode: false, @@ -37,8 +36,7 @@ const buildGridContext = (dataView: DataView, rows: ElasticSearchHit[]): GridCon rowIndex, columnId, services: discoverServiceMock, - rows, - rowsFlattened, + rows: usedRows, dataView, options, }), diff --git a/src/plugins/discover/public/application/context/__mocks__/use_context_app_fetch.tsx b/src/plugins/discover/public/application/context/__mocks__/use_context_app_fetch.tsx index 1499067d2332e..be424f12d93f3 100644 --- a/src/plugins/discover/public/application/context/__mocks__/use_context_app_fetch.tsx +++ b/src/plugins/discover/public/application/context/__mocks__/use_context_app_fetch.tsx @@ -6,14 +6,20 @@ * Side Public License, v 1. */ -export const mockAnchorHit = { - _id: '123', - _index: 'the-index-pattern-id', - fields: { order_date: ['2021-06-07T18:52:17.000Z'] }, - sort: [1623091937000, 2092], - isAnchor: true, - _version: 1, -}; +import { indexPatternMock } from '../../../__mocks__/index_pattern'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; + +export const mockAnchorHit = buildDataTableRecord( + { + _id: '123', + _index: 'the-index-pattern-id', + fields: { order_date: ['2021-06-07T18:52:17.000Z'] }, + sort: [1623091937000, 2092], + _version: 1, + }, + indexPatternMock, + true +); export const mockPredecessorHits = [ { @@ -37,7 +43,7 @@ export const mockPredecessorHits = [ sort: ['2021-06-07T19:10:22.000Z', 2435], _version: 1, }, -]; +].map((entry) => buildDataTableRecord(entry, indexPatternMock)); export const mockSuccessorHits = [ { @@ -61,4 +67,4 @@ export const mockSuccessorHits = [ sort: ['2021-06-07T18:47:16.000Z', 2437], _version: 1, }, -]; +].map((entry) => buildDataTableRecord(entry, indexPatternMock)); diff --git a/src/plugins/discover/public/application/context/context_app.tsx b/src/plugins/discover/public/application/context/context_app.tsx index b56364781206b..47650b64ae8cf 100644 --- a/src/plugins/discover/public/application/context/context_app.tsx +++ b/src/plugins/discover/public/application/context/context_app.tsx @@ -95,7 +95,7 @@ export const ContextApp = ({ indexPattern, anchorId }: ContextAppProps) => { fetchContextRows, fetchAllRows, fetchSurroundingRows, - fetchedState.anchor._id, + fetchedState.anchor.id, ]); const { columns, onAddColumn, onRemoveColumn, onSetColumns } = useColumns({ @@ -110,7 +110,7 @@ export const ContextApp = ({ indexPattern, anchorId }: ContextAppProps) => { const rows = useMemo( () => [ ...(fetchedState.predecessors || []), - ...(fetchedState.anchor._id ? [fetchedState.anchor] : []), + ...(fetchedState.anchor.id ? [fetchedState.anchor] : []), ...(fetchedState.successors || []), ], [fetchedState.predecessors, fetchedState.anchor, fetchedState.successors] diff --git a/src/plugins/discover/public/application/context/context_app_content.test.tsx b/src/plugins/discover/public/application/context/context_app_content.test.tsx index 9751f0d38f3d0..23a475c38b940 100644 --- a/src/plugins/discover/public/application/context/context_app_content.test.tsx +++ b/src/plugins/discover/public/application/context/context_app_content.test.tsx @@ -18,8 +18,8 @@ import { indexPatternMock } from '../../__mocks__/index_pattern'; import { DiscoverGrid } from '../../components/discover_grid/discover_grid'; import { discoverServiceMock } from '../../__mocks__/services'; import { DocTableWrapper } from '../../components/doc_table/doc_table_wrapper'; -import { EsHitRecordList } from '../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { buildDataTableRecord } from '../../utils/build_data_record'; describe('ContextAppContent test', () => { const mountComponent = ({ @@ -56,7 +56,7 @@ describe('ContextAppContent test', () => { anchorStatus: anchorStatus || LoadingStatus.LOADED, predecessorsStatus: LoadingStatus.LOADED, successorsStatus: LoadingStatus.LOADED, - rows: [hit] as unknown as EsHitRecordList, + rows: [buildDataTableRecord(hit, indexPatternMock)], predecessors: [], successors: [], defaultStepSize: 5, diff --git a/src/plugins/discover/public/application/context/context_app_content.tsx b/src/plugins/discover/public/application/context/context_app_content.tsx index 0c14c3bd62e34..ce9dd8af939d3 100644 --- a/src/plugins/discover/public/application/context/context_app_content.tsx +++ b/src/plugins/discover/public/application/context/context_app_content.tsx @@ -20,10 +20,9 @@ import { AppState } from './services/context_state'; import { SurrDocType } from './services/context'; import { MAX_CONTEXT_SIZE, MIN_CONTEXT_SIZE } from './services/constants'; import { DocTableContext } from '../../components/doc_table/doc_table_context'; -import { EsHitRecordList } from '../types'; -import { SortPairArr } from '../../components/doc_table/utils/get_sort'; -import { ElasticSearchHit } from '../../types'; +import type { SortPairArr } from '../../components/doc_table/utils/get_sort'; import { useDiscoverServices } from '../../hooks/use_discover_services'; +import type { DataTableRecord } from '../../types'; export interface ContextAppContentProps { columns: string[]; @@ -33,9 +32,9 @@ export interface ContextAppContentProps { indexPattern: DataView; predecessorCount: number; successorCount: number; - rows: EsHitRecordList; - predecessors: EsHitRecordList; - successors: EsHitRecordList; + rows: DataTableRecord[]; + predecessors: DataTableRecord[]; + successors: DataTableRecord[]; anchorStatus: LoadingStatus; predecessorsStatus: LoadingStatus; successorsStatus: LoadingStatus; @@ -76,7 +75,7 @@ export function ContextAppContent({ }: ContextAppContentProps) { const { uiSettings: config } = useDiscoverServices(); - const [expandedDoc, setExpandedDoc] = useState(); + const [expandedDoc, setExpandedDoc] = useState(); const isAnchorLoading = anchorStatus === LoadingStatus.LOADING || anchorStatus === LoadingStatus.UNINITIALIZED; const arePredecessorsLoading = diff --git a/src/plugins/discover/public/application/context/hooks/use_context_app_fetch.tsx b/src/plugins/discover/public/application/context/hooks/use_context_app_fetch.tsx index a43b8b0ca4f9d..1201526da0821 100644 --- a/src/plugins/discover/public/application/context/hooks/use_context_app_fetch.tsx +++ b/src/plugins/discover/public/application/context/hooks/use_context_app_fetch.tsx @@ -21,8 +21,8 @@ import { } from '../services/context_query_state'; import { AppState } from '../services/context_state'; import { getFirstSortableField } from '../utils/sorting'; -import { EsHitRecord } from '../../types'; import { useDiscoverServices } from '../../../hooks/use_discover_services'; +import type { DataTableRecord } from '../../../types'; const createError = (statusKey: string, reason: FailureReason, error?: Error) => ({ [statusKey]: { value: LoadingStatus.FAILED, error, reason }, @@ -117,7 +117,7 @@ export function useContextAppFetch({ ]); const fetchSurroundingRows = useCallback( - async (type: SurrDocType, fetchedAnchor?: EsHitRecord) => { + async (type: SurrDocType, fetchedAnchor?: DataTableRecord) => { const filters = filterManager.getFilters(); const count = @@ -133,7 +133,7 @@ export function useContextAppFetch({ const rows = await fetchSurroundingDocs( type, indexPattern, - anchor as EsHitRecord, + anchor, tieBreakerField, SortDirection.desc, count, @@ -167,7 +167,7 @@ export function useContextAppFetch({ ); const fetchContextRows = useCallback( - (anchor?: EsHitRecord) => + (anchor?: DataTableRecord) => Promise.allSettled([ fetchSurroundingRows(SurrDocType.PREDECESSORS, anchor), fetchSurroundingRows(SurrDocType.SUCCESSORS, anchor), diff --git a/src/plugins/discover/public/application/context/services/_stubs.ts b/src/plugins/discover/public/application/context/services/_stubs.ts index b37c1ecf4efbf..f2375372829bc 100644 --- a/src/plugins/discover/public/application/context/services/_stubs.ts +++ b/src/plugins/discover/public/application/context/services/_stubs.ts @@ -11,7 +11,7 @@ import moment from 'moment'; import { of } from 'rxjs'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { IKibanaSearchResponse } from '@kbn/data-plugin/common'; -import { EsHitRecordList } from '../../types'; +import { EsHitRecord } from '../../../types'; type SortHit = { [key in string]: number; // timeField name @@ -22,7 +22,7 @@ type SortHit = { /** * A stubbed search source with a `fetch` method that returns all of `_stubHits`. */ -export function createSearchSourceStub(hits: EsHitRecordList, timeField?: string) { +export function createSearchSourceStub(hits: EsHitRecord[], timeField?: string) { const requestResult = { id: 'Fjk5bndxTHJWU2FldVRVQ0tYR0VqOFEcRWtWNDhOdG5SUzJYcFhONVVZVTBJQToxMDMwOQ==', rawResponse: { diff --git a/src/plugins/discover/public/application/context/services/anchor.test.ts b/src/plugins/discover/public/application/context/services/anchor.test.ts index ab613fb71cc6d..0fff0193e4995 100644 --- a/src/plugins/discover/public/application/context/services/anchor.test.ts +++ b/src/plugins/discover/public/application/context/services/anchor.test.ts @@ -11,7 +11,6 @@ import { createSearchSourceStub } from './_stubs'; import { fetchAnchor, updateSearchSource } from './anchor'; import { indexPatternMock } from '../../../__mocks__/index_pattern'; import { savedSearchMock } from '../../../__mocks__/saved_search'; -import { EsHitRecordList } from '../../types'; describe('context app', function () { // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -24,7 +23,7 @@ describe('context app', function () { describe('function fetchAnchor', function () { beforeEach(() => { - searchSourceStub = createSearchSourceStub([{ _id: 'hit1' }] as unknown as EsHitRecordList); + searchSourceStub = createSearchSourceStub([{ _id: 'hit1', _index: 'test' }]); }); it('should use the `fetch$` method of the SearchSource', function () { @@ -142,7 +141,7 @@ describe('context app', function () { }); it('should reject with an error when no hits were found', function () { - searchSourceStub = createSearchSourceStub([] as unknown as EsHitRecordList); + searchSourceStub = createSearchSourceStub([]); return fetchAnchor('id', indexPattern, searchSourceStub, [ { '@timestamp': SortDirection.desc }, @@ -159,15 +158,15 @@ describe('context app', function () { it('should return the first hit after adding an anchor marker', function () { searchSourceStub = createSearchSourceStub([ - { property1: 'value1' }, - { property2: 'value2' }, - ] as unknown as EsHitRecordList); + { _id: '1', _index: 't' }, + { _id: '3', _index: 't' }, + ]); return fetchAnchor('id', indexPattern, searchSourceStub, [ { '@timestamp': SortDirection.desc }, { _doc: SortDirection.desc }, ]).then((anchorDocument) => { - expect(anchorDocument).toHaveProperty('property1', 'value1'); + expect(anchorDocument).toHaveProperty('raw._id', '1'); expect(anchorDocument).toHaveProperty('isAnchor', true); }); }); @@ -175,7 +174,7 @@ describe('context app', function () { describe('useNewFields API', () => { beforeEach(() => { - searchSourceStub = createSearchSourceStub([{ _id: 'hit1' }] as unknown as EsHitRecordList); + searchSourceStub = createSearchSourceStub([{ _id: 'hit1', _index: 't' }]); }); it('should request fields if useNewFieldsApi set', function () { diff --git a/src/plugins/discover/public/application/context/services/anchor.ts b/src/plugins/discover/public/application/context/services/anchor.ts index 28d2298513aa7..77644c8af5808 100644 --- a/src/plugins/discover/public/application/context/services/anchor.ts +++ b/src/plugins/discover/public/application/context/services/anchor.ts @@ -9,7 +9,8 @@ import { lastValueFrom } from 'rxjs'; import { i18n } from '@kbn/i18n'; import { ISearchSource, EsQuerySortValue } from '@kbn/data-plugin/public'; import { DataView } from '@kbn/data-views-plugin/public'; -import { EsHitRecord } from '../../types'; +import { DataTableRecord } from '../../../types'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; export async function fetchAnchor( anchorId: string, @@ -17,7 +18,7 @@ export async function fetchAnchor( searchSource: ISearchSource, sort: EsQuerySortValue[], useNewFieldsApi: boolean = false -): Promise { +): Promise { updateSearchSource(searchSource, anchorId, sort, useNewFieldsApi, indexPattern); const { rawResponse } = await lastValueFrom(await searchSource.fetch$()); const doc = rawResponse.hits?.hits?.[0]; @@ -29,11 +30,7 @@ export async function fetchAnchor( }) ); } - - return { - ...doc, - isAnchor: true, - } as EsHitRecord; + return buildDataTableRecord(doc, indexPattern, true); } export function updateSearchSource( diff --git a/src/plugins/discover/public/application/context/services/context.predecessors.test.ts b/src/plugins/discover/public/application/context/services/context.predecessors.test.ts index d9b55303ad507..42d53dc66a878 100644 --- a/src/plugins/discover/public/application/context/services/context.predecessors.test.ts +++ b/src/plugins/discover/public/application/context/services/context.predecessors.test.ts @@ -14,7 +14,8 @@ import { Query } from '@kbn/es-query'; import { createContextSearchSourceStub } from './_stubs'; import { fetchSurroundingDocs, SurrDocType } from './context'; import { DataPublicPluginStart } from '@kbn/data-plugin/public'; -import { EsHitRecord, EsHitRecordList } from '../../types'; +import { DataTableRecord, EsHitRecord } from '../../../types'; +import { buildDataTableRecord, buildDataTableRecordList } from '../../../utils/build_data_record'; const MS_PER_DAY = 24 * 60 * 60 * 1000; const ANCHOR_TIMESTAMP = new Date(MS_PER_DAY).toJSON(); @@ -36,7 +37,7 @@ describe('context predecessors', function () { tieBreakerField: string, tieBreakerValue: number, size: number - ) => Promise; + ) => Promise; // eslint-disable-next-line @typescript-eslint/no-explicit-any let mockSearchSource: any; @@ -45,6 +46,9 @@ describe('context predecessors', function () { timeFieldName: '@timestamp', isTimeNanosBased: () => false, popularizeField: () => {}, + fields: { + getByName: jest.fn(), + }, } as unknown as DataView; describe('function fetchPredecessors', function () { @@ -59,17 +63,21 @@ describe('context predecessors', function () { } as unknown as DataPublicPluginStart; fetchPredecessors = (timeValIso, timeValNr, tieBreakerField, tieBreakerValue, size = 10) => { - const anchor = { - _source: { - [indexPattern.timeFieldName!]: timeValIso, - }, - sort: [timeValNr, tieBreakerValue], - }; + const anchor = buildDataTableRecord( + { + _source: { + [indexPattern.timeFieldName!]: timeValIso, + }, + sort: [timeValNr, tieBreakerValue], + } as EsHitRecord, + indexPattern, + true + ); return fetchSurroundingDocs( SurrDocType.PREDECESSORS, indexPattern, - anchor as EsHitRecord, + anchor, tieBreakerField, SortDirection.desc, size, @@ -89,9 +97,11 @@ describe('context predecessors', function () { ]; return fetchPredecessors(ANCHOR_TIMESTAMP_3000, MS_PER_DAY * 3000, '_doc', 0, 3).then( - (hits: EsHitRecordList) => { + (hits) => { expect(mockSearchSource.fetch$.calledOnce).toBe(true); - expect(hits).toEqual(mockSearchSource._stubHits.slice(0, 3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(0, 3), indexPattern) + ); } ); }); @@ -106,7 +116,7 @@ describe('context predecessors', function () { ]; return fetchPredecessors(ANCHOR_TIMESTAMP_3000, MS_PER_DAY * 3000, '_doc', 0, 6).then( - (hits: EsHitRecordList) => { + (hits) => { const intervals: Timestamp[] = mockSearchSource.setField.args .filter(([property]: string) => property === 'query') .map(([, { query }]: [string, { query: Query }]) => @@ -121,8 +131,9 @@ describe('context predecessors', function () { // should have ended with a half-open interval expect(Object.keys(last(intervals) ?? {})).toEqual(['format', 'gte']); expect(intervals.length).toBeGreaterThan(1); - - expect(hits).toEqual(mockSearchSource._stubHits.slice(0, 3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(0, 3), indexPattern) + ); } ); }); @@ -136,7 +147,7 @@ describe('context predecessors', function () { ]; return fetchPredecessors(ANCHOR_TIMESTAMP_1000, MS_PER_DAY * 1000, '_doc', 0, 3).then( - (hits: EsHitRecordList) => { + (hits) => { const intervals: Timestamp[] = mockSearchSource.setField.args .filter(([property]: string) => property === 'query') .map(([, { query }]: [string, { query: Query }]) => { @@ -155,17 +166,18 @@ describe('context predecessors', function () { // should have stopped before reaching MS_PER_DAY * 1700 expect(moment(last(intervals)?.lte).valueOf()).toBeLessThan(MS_PER_DAY * 1700); expect(intervals.length).toBeGreaterThan(1); - expect(hits).toEqual(mockSearchSource._stubHits.slice(-3)); + + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(-3), indexPattern) + ); } ); }); it('should return an empty array when no hits were found', function () { - return fetchPredecessors(ANCHOR_TIMESTAMP_3, MS_PER_DAY * 3, '_doc', 0, 3).then( - (hits: EsHitRecordList) => { - expect(hits).toEqual([]); - } - ); + return fetchPredecessors(ANCHOR_TIMESTAMP_3, MS_PER_DAY * 3, '_doc', 0, 3).then((hits) => { + expect(hits).toEqual([]); + }); }); it('should configure the SearchSource to not inherit from the implicit root', function () { @@ -201,17 +213,21 @@ describe('context predecessors', function () { } as unknown as DataPublicPluginStart; fetchPredecessors = (timeValIso, timeValNr, tieBreakerField, tieBreakerValue, size = 10) => { - const anchor = { - _source: { - [indexPattern.timeFieldName!]: timeValIso, - }, - sort: [timeValNr, tieBreakerValue], - }; + const anchor = buildDataTableRecord( + { + _source: { + [indexPattern.timeFieldName!]: timeValIso, + }, + sort: [timeValNr, tieBreakerValue], + } as EsHitRecord, + indexPattern, + true + ); return fetchSurroundingDocs( SurrDocType.PREDECESSORS, indexPattern, - anchor as EsHitRecord, + anchor, tieBreakerField, SortDirection.desc, size, @@ -232,13 +248,15 @@ describe('context predecessors', function () { ]; return fetchPredecessors(ANCHOR_TIMESTAMP_3000, MS_PER_DAY * 3000, '_doc', 0, 3).then( - (hits: EsHitRecordList) => { + (hits) => { const setFieldsSpy = mockSearchSource.setField.withArgs('fields'); const removeFieldsSpy = mockSearchSource.removeField.withArgs('fieldsFromSource'); expect(mockSearchSource.fetch$.calledOnce).toBe(true); expect(removeFieldsSpy.calledOnce).toBe(true); expect(setFieldsSpy.calledOnce).toBe(true); - expect(hits).toEqual(mockSearchSource._stubHits.slice(0, 3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(0, 3), indexPattern) + ); } ); }); diff --git a/src/plugins/discover/public/application/context/services/context.successors.test.ts b/src/plugins/discover/public/application/context/services/context.successors.test.ts index c9f819c6497d9..dfc57b1859cb1 100644 --- a/src/plugins/discover/public/application/context/services/context.successors.test.ts +++ b/src/plugins/discover/public/application/context/services/context.successors.test.ts @@ -14,7 +14,8 @@ import { createContextSearchSourceStub } from './_stubs'; import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { Query } from '@kbn/es-query'; import { fetchSurroundingDocs, SurrDocType } from './context'; -import { EsHitRecord, EsHitRecordList } from '../../types'; +import { DataTableRecord } from '../../../types'; +import { buildDataTableRecord, buildDataTableRecordList } from '../../../utils/build_data_record'; const MS_PER_DAY = 24 * 60 * 60 * 1000; const ANCHOR_TIMESTAMP = new Date(MS_PER_DAY).toJSON(); @@ -34,7 +35,7 @@ describe('context successors', function () { tieBreakerField: string, tieBreakerValue: number, size: number - ) => Promise; + ) => Promise; let dataPluginMock: DataPublicPluginStart; // eslint-disable-next-line @typescript-eslint/no-explicit-any let mockSearchSource: any; @@ -43,6 +44,9 @@ describe('context successors', function () { timeFieldName: '@timestamp', isTimeNanosBased: () => false, popularizeField: () => {}, + fields: { + getByName: jest.fn(), + }, } as unknown as DataView; describe('function fetchSuccessors', function () { @@ -58,17 +62,23 @@ describe('context successors', function () { } as unknown as DataPublicPluginStart; fetchSuccessors = (timeValIso, timeValNr, tieBreakerField, tieBreakerValue, size) => { - const anchor = { - _source: { - [indexPattern.timeFieldName!]: timeValIso, + const anchor = buildDataTableRecord( + { + _index: 't', + _id: '1', + _source: { + [indexPattern.timeFieldName!]: timeValIso, + }, + sort: [timeValNr, tieBreakerValue], }, - sort: [timeValNr, tieBreakerValue], - }; + indexPattern, + true + ); return fetchSurroundingDocs( SurrDocType.SUCCESSORS, indexPattern, - anchor as EsHitRecord, + anchor, tieBreakerField, SortDirection.desc, size, @@ -90,7 +100,9 @@ describe('context successors', function () { return fetchSuccessors(ANCHOR_TIMESTAMP_3000, MS_PER_DAY * 3000, '_doc', 0, 3).then( (hits) => { expect(mockSearchSource.fetch$.calledOnce).toBe(true); - expect(hits).toEqual(mockSearchSource._stubHits.slice(-3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(-3), indexPattern) + ); } ); }); @@ -120,8 +132,9 @@ describe('context successors', function () { // should have ended with a half-open interval expect(Object.keys(last(intervals) ?? {})).toEqual(['format', 'lte']); expect(intervals.length).toBeGreaterThan(1); - - expect(hits).toEqual(mockSearchSource._stubHits.slice(-3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(-3), indexPattern) + ); } ); }); @@ -149,8 +162,9 @@ describe('context successors', function () { // should have stopped before reaching MS_PER_DAY * 2200 expect(moment(last(intervals)?.gte).valueOf()).toBeGreaterThan(MS_PER_DAY * 2200); expect(intervals.length).toBeGreaterThan(1); - - expect(hits).toEqual(mockSearchSource._stubHits.slice(0, 4)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(0, 4), indexPattern) + ); } ); }); @@ -194,17 +208,23 @@ describe('context successors', function () { } as unknown as DataPublicPluginStart; fetchSuccessors = (timeValIso, timeValNr, tieBreakerField, tieBreakerValue, size) => { - const anchor = { - _source: { - [indexPattern.timeFieldName!]: timeValIso, + const anchor = buildDataTableRecord( + { + _id: '1', + _index: 'test', + _source: { + [indexPattern.timeFieldName!]: timeValIso, + }, + sort: [timeValNr, tieBreakerValue], }, - sort: [timeValNr, tieBreakerValue], - }; + indexPattern, + true + ); return fetchSurroundingDocs( SurrDocType.SUCCESSORS, indexPattern, - anchor as EsHitRecord, + anchor, tieBreakerField, SortDirection.desc, size, @@ -227,7 +247,9 @@ describe('context successors', function () { return fetchSuccessors(ANCHOR_TIMESTAMP_3000, MS_PER_DAY * 3000, '_doc', 0, 3).then( (hits) => { expect(mockSearchSource.fetch$.calledOnce).toBe(true); - expect(hits).toEqual(mockSearchSource._stubHits.slice(-3)); + expect(hits).toEqual( + buildDataTableRecordList(mockSearchSource._stubHits.slice(-3), indexPattern) + ); const setFieldsSpy = mockSearchSource.setField.withArgs('fields'); const removeFieldsSpy = mockSearchSource.removeField.withArgs('fieldsFromSource'); expect(removeFieldsSpy.calledOnce).toBe(true); diff --git a/src/plugins/discover/public/application/context/services/context.ts b/src/plugins/discover/public/application/context/services/context.ts index 336ca6a21cc33..c2f2b7f765f73 100644 --- a/src/plugins/discover/public/application/context/services/context.ts +++ b/src/plugins/discover/public/application/context/services/context.ts @@ -14,7 +14,7 @@ import { fetchHitsInInterval } from '../utils/fetch_hits_in_interval'; import { generateIntervals } from '../utils/generate_intervals'; import { getEsQuerySearchAfter } from '../utils/get_es_query_search_after'; import { getEsQuerySort } from '../utils/get_es_query_sort'; -import { EsHitRecord, EsHitRecordList } from '../../types'; +import { DataTableRecord } from '../../../types'; export enum SurrDocType { SUCCESSORS = 'successors', @@ -31,7 +31,7 @@ const LOOKUP_OFFSETS = [0, 1, 7, 30, 365, 10000].map((days) => days * DAY_MILLIS * * @param {SurrDocType} type - `successors` or `predecessors` * @param {DataView} indexPattern - * @param {EsHitRecord} anchor - anchor record + * @param {DataTableRecord} anchor - anchor record * @param {string} tieBreakerField - name of the tie breaker, the 2nd sort field * @param {SortDirection} sortDir - direction of sorting * @param {number} size - number of records to retrieve @@ -42,14 +42,14 @@ const LOOKUP_OFFSETS = [0, 1, 7, 30, 365, 10000].map((days) => days * DAY_MILLIS export async function fetchSurroundingDocs( type: SurrDocType, indexPattern: DataView, - anchor: EsHitRecord, + anchor: DataTableRecord, tieBreakerField: string, sortDir: SortDirection, size: number, filters: Filter[], data: DataPublicPluginStart, useNewFieldsApi?: boolean -): Promise { +): Promise { if (typeof anchor !== 'object' || anchor === null || !size) { return []; } @@ -57,13 +57,16 @@ export async function fetchSurroundingDocs( const searchSource = data.search.searchSource.createEmpty(); updateSearchSource(searchSource, indexPattern, filters, Boolean(useNewFieldsApi)); const sortDirToApply = type === SurrDocType.SUCCESSORS ? sortDir : reverseSortDir(sortDir); + const anchorRaw = anchor.raw!; - const nanos = indexPattern.isTimeNanosBased() ? extractNanos(anchor.fields[timeField][0]) : ''; + const nanos = indexPattern.isTimeNanosBased() + ? extractNanos(anchorRaw.fields?.[timeField][0]) + : ''; const timeValueMillis = - nanos !== '' ? convertIsoToMillis(anchor.fields[timeField][0]) : anchor.sort[0]; + nanos !== '' ? convertIsoToMillis(anchorRaw.fields?.[timeField][0]) : anchorRaw.sort?.[0]; const intervals = generateIntervals(LOOKUP_OFFSETS, timeValueMillis as number, type, sortDir); - let documents: EsHitRecordList = []; + let documents: DataTableRecord[] = []; for (const interval of intervals) { const remainingSize = size - documents.length; @@ -92,7 +95,7 @@ export async function fetchSurroundingDocs( searchAfter, remainingSize, nanos, - anchor._id + anchor.raw._id ); documents = diff --git a/src/plugins/discover/public/application/context/services/context_query_state.ts b/src/plugins/discover/public/application/context/services/context_query_state.ts index 3a6a4c0959ea6..611c7666b52fb 100644 --- a/src/plugins/discover/public/application/context/services/context_query_state.ts +++ b/src/plugins/discover/public/application/context/services/context_query_state.ts @@ -6,21 +6,21 @@ * Side Public License, v 1. */ -import { EsHitRecord, EsHitRecordList } from '../../types'; +import { DataTableRecord } from '../../../types'; export interface ContextFetchState { /** * Documents listed before anchor */ - predecessors: EsHitRecordList; + predecessors: DataTableRecord[]; /** * Documents after anchor */ - successors: EsHitRecordList; + successors: DataTableRecord[]; /** * Anchor document */ - anchor: EsHitRecord; + anchor: DataTableRecord; /** * Anchor fetch status */ @@ -54,7 +54,7 @@ export interface LoadingStatusEntry { } export const getInitialContextQueryState = (): ContextFetchState => ({ - anchor: {} as EsHitRecord, + anchor: {} as DataTableRecord, predecessors: [], successors: [], anchorStatus: { value: LoadingStatus.UNINITIALIZED }, diff --git a/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts b/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts index 3547127c1ab8c..cd805a5e4f1a6 100644 --- a/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts +++ b/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts @@ -7,10 +7,11 @@ */ import { lastValueFrom } from 'rxjs'; import { ISearchSource, EsQuerySortValue, SortDirection } from '@kbn/data-plugin/public'; +import { EsQuerySearchAfter } from '@kbn/data-plugin/common'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; import { convertTimeValueToIso } from './date_conversion'; import { IntervalValue } from './generate_intervals'; -import { EsQuerySearchAfter } from './get_es_query_search_after'; -import { EsHitRecord, EsHitRecordList } from '../../types'; +import type { DataTableRecord } from '../../../types'; interface RangeQuery { format: string; @@ -35,7 +36,7 @@ export async function fetchHitsInInterval( maxCount: number, nanosValue: string, anchorId: string -): Promise { +): Promise { const range: RangeQuery = { format: 'strict_date_optional_time', }; @@ -77,7 +78,8 @@ export async function fetchHitsInInterval( .fetch$(); const { rawResponse } = await lastValueFrom(fetch$); + const dataView = searchSource.getField('index'); + const records = rawResponse.hits?.hits.map((hit) => buildDataTableRecord(hit, dataView!)); - // TODO: There's a difference in the definition of SearchResponse and EsHitRecord - return (rawResponse.hits?.hits as unknown as EsHitRecord[]) || []; + return records ?? []; } diff --git a/src/plugins/discover/public/application/context/utils/get_es_query_search_after.ts b/src/plugins/discover/public/application/context/utils/get_es_query_search_after.ts index 85a68376fe43b..bfec54c61e856 100644 --- a/src/plugins/discover/public/application/context/utils/get_es_query_search_after.ts +++ b/src/plugins/discover/public/application/context/utils/get_es_query_search_after.ts @@ -5,11 +5,9 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - +import type { EsQuerySearchAfter } from '@kbn/data-plugin/common'; import { SurrDocType } from '../services/context'; -import { EsHitRecord, EsHitRecordList } from '../../types'; - -export type EsQuerySearchAfter = [string | number, string | number]; +import type { DataTableRecord } from '../../../types'; /** * Get the searchAfter query value for elasticsearch @@ -19,9 +17,9 @@ export type EsQuerySearchAfter = [string | number, string | number]; */ export function getEsQuerySearchAfter( type: SurrDocType, - documents: EsHitRecordList, + documents: DataTableRecord[], timeFieldName: string, - anchor: EsHitRecord, + anchor: DataTableRecord, nanoSeconds: string, useNewFieldsApi?: boolean ): EsQuerySearchAfter { @@ -30,23 +28,24 @@ export function getEsQuerySearchAfter( const afterTimeRecIdx = type === SurrDocType.SUCCESSORS && documents.length ? documents.length - 1 : 0; const afterTimeDoc = documents[afterTimeRecIdx]; - let afterTimeValue = afterTimeDoc.sort[0] as string | number; + const afterTimeDocRaw = afterTimeDoc.raw; + let afterTimeValue = afterTimeDocRaw.sort?.[0] as string | number; if (nanoSeconds) { afterTimeValue = useNewFieldsApi - ? afterTimeDoc.fields[timeFieldName][0] - : afterTimeDoc._source?.[timeFieldName]; + ? afterTimeDocRaw.fields?.[timeFieldName][0] + : afterTimeDocRaw._source?.[timeFieldName]; } - return [afterTimeValue, afterTimeDoc.sort[1] as string | number]; + return [afterTimeValue, afterTimeDoc.raw.sort?.[1] as string | number]; } // if data_nanos adapt timestamp value for sorting, since numeric value was rounded by browser // ES search_after also works when number is provided as string const searchAfter = new Array(2) as EsQuerySearchAfter; - searchAfter[0] = anchor.sort[0] as string | number; + searchAfter[0] = anchor.raw.sort?.[0] as string | number; if (nanoSeconds) { searchAfter[0] = useNewFieldsApi - ? anchor.fields[timeFieldName][0] - : anchor._source?.[timeFieldName]; + ? anchor.raw.fields?.[timeFieldName][0] + : anchor.raw._source?.[timeFieldName]; } - searchAfter[1] = anchor.sort[1] as string | number; + searchAfter[1] = anchor.raw.sort?.[1] as string | number; return searchAfter; } diff --git a/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx b/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx index 01d5aae129a72..b76b6d6a1ce07 100644 --- a/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx +++ b/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx @@ -18,12 +18,13 @@ import { discoverServiceMock } from '../../../../__mocks__/services'; import { FetchStatus } from '../../../types'; import { DiscoverDocuments } from './discover_documents'; import { indexPatternMock } from '../../../../__mocks__/index_pattern'; -import { ElasticSearchHit } from '../../../../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { buildDataTableRecord } from '../../../../utils/build_data_record'; +import { EsHitRecord } from '../../../../types'; setHeaderActionMenuMounter(jest.fn()); -function mountComponent(fetchStatus: FetchStatus, hits: ElasticSearchHit[]) { +function mountComponent(fetchStatus: FetchStatus, hits: EsHitRecord[]) { const services = discoverServiceMock; services.data.query.timefilter.timefilter.getTime = () => { return { from: '2020-05-14T11:05:13.590', to: '2020-05-14T11:20:13.590' }; @@ -31,7 +32,7 @@ function mountComponent(fetchStatus: FetchStatus, hits: ElasticSearchHit[]) { const documents$ = new BehaviorSubject({ fetchStatus, - result: hits, + result: hits.map((hit) => buildDataTableRecord(hit, indexPatternMock)), }) as DataDocuments$; const props = { @@ -62,13 +63,13 @@ describe('Discover documents layout', () => { }); test('render complete when loading but documents were already fetched', () => { - const component = mountComponent(FetchStatus.LOADING, esHits as ElasticSearchHit[]); + const component = mountComponent(FetchStatus.LOADING, esHits); expect(component.find('.dscDocuments__loading').exists()).toBeFalsy(); expect(component.find('.dscTable').exists()).toBeTruthy(); }); test('render complete', () => { - const component = mountComponent(FetchStatus.COMPLETE, esHits as ElasticSearchHit[]); + const component = mountComponent(FetchStatus.COMPLETE, esHits); expect(component.find('.dscDocuments__loading').exists()).toBeFalsy(); expect(component.find('.dscTable').exists()).toBeTruthy(); }); diff --git a/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx b/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx index 530118cb8f1c9..3dbf313fcc7c7 100644 --- a/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx +++ b/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx @@ -32,10 +32,10 @@ import { AppState, GetStateReturn } from '../../services/discover_state'; import { useDataState } from '../../hooks/use_data_state'; import { DocTableInfinite } from '../../../../components/doc_table/doc_table_infinite'; import { SortPairArr } from '../../../../components/doc_table/utils/get_sort'; -import { ElasticSearchHit } from '../../../../types'; import { DocumentExplorerCallout } from '../document_explorer_callout'; import { DocumentExplorerUpdateCallout } from '../document_explorer_callout/document_explorer_update_callout'; import { DiscoverTourProvider } from '../../../../components/discover_tour'; +import { DataTableRecord } from '../../../../types'; const DocTableInfiniteMemoized = React.memo(DocTableInfinite); const DataGridMemoized = React.memo(DiscoverGrid); @@ -51,12 +51,12 @@ function DiscoverDocumentsComponent({ stateContainer, }: { documents$: DataDocuments$; - expandedDoc?: ElasticSearchHit; + expandedDoc?: DataTableRecord; indexPattern: DataView; navigateTo: (url: string) => void; onAddFilter: DocViewFilterFn; savedSearch: SavedSearch; - setExpandedDoc: (doc?: ElasticSearchHit) => void; + setExpandedDoc: (doc?: DataTableRecord) => void; state: AppState; stateContainer: GetStateReturn; }) { diff --git a/src/plugins/discover/public/application/main/components/layout/discover_layout.test.tsx b/src/plugins/discover/public/application/main/components/layout/discover_layout.test.tsx index 1025270dab355..4aff6e2a78070 100644 --- a/src/plugins/discover/public/application/main/components/layout/discover_layout.test.tsx +++ b/src/plugins/discover/public/application/main/components/layout/discover_layout.test.tsx @@ -32,10 +32,10 @@ import { FetchStatus } from '../../../types'; import { RequestAdapter } from '@kbn/inspector-plugin'; import { Chart } from '../chart/point_series'; import { DiscoverSidebar } from '../sidebar/discover_sidebar'; -import { ElasticSearchHit } from '../../../../types'; import { LocalStorageMock } from '../../../../__mocks__/local_storage_mock'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { DiscoverServices } from '../../../../build_services'; +import { buildDataTableRecord } from '../../../../utils/build_data_record'; setHeaderActionMenuMounter(jest.fn()); @@ -66,7 +66,7 @@ function mountComponent( const documents$ = new BehaviorSubject({ fetchStatus: FetchStatus.COMPLETE, - result: esHits as ElasticSearchHit[], + result: esHits.map((esHit) => buildDataTableRecord(esHit, indexPattern)), }) as DataDocuments$; const availableFields$ = new BehaviorSubject({ diff --git a/src/plugins/discover/public/application/main/components/layout/types.ts b/src/plugins/discover/public/application/main/components/layout/types.ts index e7bcfb3bc3971..f381f87c7389d 100644 --- a/src/plugins/discover/public/application/main/components/layout/types.ts +++ b/src/plugins/discover/public/application/main/components/layout/types.ts @@ -11,10 +11,10 @@ import type { SavedObject } from '@kbn/data-plugin/public'; import type { DataView, DataViewAttributes } from '@kbn/data-views-plugin/public'; import { ISearchSource } from '@kbn/data-plugin/public'; import { RequestAdapter } from '@kbn/inspector-plugin'; +import { DataTableRecord } from '../../../../types'; import { AppState, GetStateReturn } from '../../services/discover_state'; import { DataRefetch$, SavedSearchData } from '../../hooks/use_saved_search'; import { SavedSearch } from '../../../../services/saved_searches'; -import { ElasticSearchHit } from '../../../../types'; export interface DiscoverLayoutProps { indexPattern: DataView; @@ -24,8 +24,8 @@ export interface DiscoverLayoutProps { onChangeIndexPattern: (id: string) => void; onUpdateQuery: (payload: { dateRange: TimeRange; query?: Query }, isUpdate?: boolean) => void; resetSavedSearch: () => void; - expandedDoc?: ElasticSearchHit; - setExpandedDoc: (doc?: ElasticSearchHit) => void; + expandedDoc?: DataTableRecord; + setExpandedDoc: (doc?: DataTableRecord) => void; savedSearch: SavedSearch; savedSearchData$: SavedSearchData; savedSearchRefetch$: DataRefetch$; diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx index 34cfde26ff32c..2bbd2e579f4aa 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.test.tsx @@ -5,18 +5,13 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -import { cloneDeep, each } from 'lodash'; import { ReactWrapper } from 'enzyme'; import { findTestSubject } from '@elastic/eui/lib/test'; import { Action } from '@kbn/ui-actions-plugin/public'; -// @ts-expect-error -import realHits from '../../../../__fixtures__/real_hits'; - +import { getDataTableRecords } from '../../../../__fixtures__/real_hits'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import React from 'react'; import { DiscoverSidebarProps } from './discover_sidebar'; -import { flattenHit } from '@kbn/data-plugin/public'; import { DataViewAttributes } from '@kbn/data-views-plugin/public'; import { SavedObject } from '@kbn/core/types'; import { getDefaultFieldFilter } from './lib/field_filter'; @@ -24,7 +19,6 @@ import { DiscoverSidebarComponent as DiscoverSidebar } from './discover_sidebar' import { discoverServiceMock as mockDiscoverServices } from '../../../../__mocks__/services'; import { stubLogstashIndexPattern } from '@kbn/data-plugin/common/stubs'; import { VIEW_MODE } from '../../../../components/view_mode_toggle'; -import { ElasticSearchHit } from '../../../../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { BehaviorSubject } from 'rxjs'; import { FetchStatus } from '../../../types'; @@ -42,9 +36,7 @@ jest.mock('../../../../kibana_services', () => ({ function getCompProps(): DiscoverSidebarProps { const indexPattern = stubLogstashIndexPattern; - const hits = each(cloneDeep(realHits), (hit) => - flattenHit(hit, indexPattern) - ) as unknown as ElasticSearchHit[]; + const hits = getDataTableRecords(indexPattern); const indexPatternList = [ { id: '0', attributes: { title: 'b' } } as SavedObject, @@ -55,7 +47,7 @@ function getCompProps(): DiscoverSidebarProps { const fieldCounts: Record = {}; for (const hit of hits) { - for (const key of Object.keys(flattenHit(hit, indexPattern))) { + for (const key of Object.keys(hit.flattened)) { fieldCounts[key] = (fieldCounts[key] || 0) + 1; } } diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx index 0141aead76eff..5ce3ad6cd147d 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar.tsx @@ -40,7 +40,7 @@ import { getIndexPatternFieldList } from './lib/get_index_pattern_field_list'; import { DiscoverSidebarResponsiveProps } from './discover_sidebar_responsive'; import { VIEW_MODE } from '../../../../components/view_mode_toggle'; import { DISCOVER_TOUR_STEP_ANCHOR_IDS } from '../../../../components/discover_tour'; -import { ElasticSearchHit } from '../../../../types'; +import type { DataTableRecord } from '../../../../types'; /** * Default number of available fields displayed and added on scroll @@ -88,7 +88,7 @@ export interface DiscoverSidebarProps extends Omit ({ function getCompProps(): DiscoverSidebarResponsiveProps { const indexPattern = stubLogstashIndexPattern; - const hits = each(cloneDeep(realHits), (hit) => - flattenHit(hit, indexPattern) - ) as unknown as ElasticSearchHit[]; + const hits = getDataTableRecords(indexPattern); const indexPatternList = [ { id: '0', attributes: { title: 'b' } } as SavedObject, @@ -90,7 +84,7 @@ function getCompProps(): DiscoverSidebarResponsiveProps { ]; for (const hit of hits) { - for (const key of Object.keys(flattenHit(hit, indexPattern))) { + for (const key of Object.keys(hit.flattened)) { mockfieldCounts[key] = (mockfieldCounts[key] || 0) + 1; } } @@ -99,7 +93,7 @@ function getCompProps(): DiscoverSidebarResponsiveProps { columns: ['extension'], documents$: new BehaviorSubject({ fetchStatus: FetchStatus.COMPLETE, - result: hits as ElasticSearchHit[], + result: hits, }) as DataDocuments$, availableFields$: new BehaviorSubject({ fetchStatus: FetchStatus.COMPLETE, diff --git a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx index c6d8d05a23ad8..e4134184306fa 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx +++ b/src/plugins/discover/public/application/main/components/sidebar/discover_sidebar_responsive.tsx @@ -123,7 +123,10 @@ export function DiscoverSidebarResponsive(props: DiscoverSidebarResponsiveProps) */ const fieldCounts = useRef | null>(null); if (fieldCounts.current === null) { - fieldCounts.current = calcFieldCounts(props.documents$.getValue().result, selectedIndexPattern); + fieldCounts.current = calcFieldCounts( + props.documents$.getValue().result!, + selectedIndexPattern + ); } const [documentState, setDocumentState] = useState(props.documents$.getValue()); @@ -266,7 +269,7 @@ export function DiscoverSidebarResponsive(props: DiscoverSidebarResponsiveProps) flattenHit(hit, dataView)); + hits = getDataTableRecords(dataView); }); it('Should return an array of values for _source fields', function () { @@ -153,7 +149,7 @@ describe('fieldCalculator', function () { let params: { hits: any; field: any; count: number; dataView: DataView }; beforeEach(function () { params = { - hits: cloneDeep(realHits), + hits: getDataTableRecords(dataView), field: dataView.fields.getByName('extension'), count: 3, dataView, diff --git a/src/plugins/discover/public/application/main/components/sidebar/lib/get_details.ts b/src/plugins/discover/public/application/main/components/sidebar/lib/get_details.ts index 78e752494c43d..99ab866a53491 100644 --- a/src/plugins/discover/public/application/main/components/sidebar/lib/get_details.ts +++ b/src/plugins/discover/public/application/main/components/sidebar/lib/get_details.ts @@ -9,11 +9,11 @@ import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; // @ts-expect-error import { fieldCalculator } from './field_calculator'; -import { ElasticSearchHit } from '../../../../../types'; +import { DataTableRecord } from '../../../../../types'; export function getDetails( field: DataViewField, - hits: ElasticSearchHit[] | undefined, + hits: DataTableRecord[] | undefined, columns: string[], indexPattern?: DataView ) { @@ -24,7 +24,6 @@ export function getDetails( ...fieldCalculator.getFieldValueCounts({ hits, field, - indexPattern, count: 5, grouped: false, }), diff --git a/src/plugins/discover/public/application/main/discover_main_app.tsx b/src/plugins/discover/public/application/main/discover_main_app.tsx index ae477719af119..6025c27a0c433 100644 --- a/src/plugins/discover/public/application/main/discover_main_app.tsx +++ b/src/plugins/discover/public/application/main/discover_main_app.tsx @@ -15,8 +15,8 @@ import { addHelpMenuToAppChrome } from '../../components/help_menu/help_menu_uti import { useDiscoverState } from './hooks/use_discover_state'; import { useUrl } from './hooks/use_url'; import { SavedSearch } from '../../services/saved_searches'; -import { ElasticSearchHit } from '../../types'; import { useDiscoverServices } from '../../hooks/use_discover_services'; +import { DataTableRecord } from '../../types'; const DiscoverLayoutMemoized = React.memo(DiscoverLayout); @@ -36,7 +36,7 @@ export function DiscoverMainApp(props: DiscoverMainProps) { const services = useDiscoverServices(); const { chrome, docLinks, uiSettings: config, data } = services; const history = useHistory(); - const [expandedDoc, setExpandedDoc] = useState(undefined); + const [expandedDoc, setExpandedDoc] = useState(undefined); const navigateTo = useCallback( (path: string) => { history.push(path); diff --git a/src/plugins/discover/public/application/main/hooks/use_discover_state.ts b/src/plugins/discover/public/application/main/hooks/use_discover_state.ts index ab481f2f67a50..2d82e12824f04 100644 --- a/src/plugins/discover/public/application/main/hooks/use_discover_state.ts +++ b/src/plugins/discover/public/application/main/hooks/use_discover_state.ts @@ -24,7 +24,7 @@ import { useSearchSession } from './use_search_session'; import { FetchStatus } from '../../types'; import { getSwitchIndexPatternAppState } from '../utils/get_switch_index_pattern_app_state'; import { SortPairArr } from '../../../components/doc_table/utils/get_sort'; -import { ElasticSearchHit } from '../../../types'; +import { DataTableRecord } from '../../../types'; export function useDiscoverState({ services, @@ -35,7 +35,7 @@ export function useDiscoverState({ services: DiscoverServices; savedSearch: SavedSearch; history: History; - setExpandedDoc: (doc?: ElasticSearchHit) => void; + setExpandedDoc: (doc?: DataTableRecord) => void; }) { const { uiSettings: config, data, filterManager, indexPatterns, storage } = services; const useNewFieldsApi = useMemo(() => !config.get(SEARCH_FIELDS_FROM_SOURCE), [config]); diff --git a/src/plugins/discover/public/application/main/hooks/use_saved_search.ts b/src/plugins/discover/public/application/main/hooks/use_saved_search.ts index d4d6b869c7ee7..0cfa1b2e97579 100644 --- a/src/plugins/discover/public/application/main/hooks/use_saved_search.ts +++ b/src/plugins/discover/public/application/main/hooks/use_saved_search.ts @@ -7,9 +7,9 @@ */ import { useCallback, useEffect, useMemo, useRef } from 'react'; import { BehaviorSubject, Subject } from 'rxjs'; +import type { AutoRefreshDoneFn } from '@kbn/data-plugin/public'; import { ISearchSource } from '@kbn/data-plugin/public'; import { RequestAdapter } from '@kbn/inspector-plugin/public'; -import type { AutoRefreshDoneFn } from '@kbn/data-plugin/public'; import { DiscoverServices } from '../../../build_services'; import { DiscoverSearchSessionManager } from '../services/discover_search_session'; import { GetStateReturn } from '../services/discover_state'; @@ -17,13 +17,12 @@ import { validateTimeRange } from '../utils/validate_time_range'; import { Chart } from '../components/chart/point_series'; import { useSingleton } from './use_singleton'; import { FetchStatus } from '../../types'; - import { fetchAll } from '../utils/fetch_all'; import { useBehaviorSubject } from './use_behavior_subject'; import { sendResetMsg } from './use_saved_search_messages'; import { getFetch$ } from '../utils/get_fetch_observable'; -import { ElasticSearchHit } from '../../../types'; import { SavedSearch } from '../../../services/saved_searches'; +import type { DataTableRecord } from '../../../types'; export interface SavedSearchData { main$: DataMain$; @@ -66,7 +65,7 @@ export interface DataMainMsg extends DataMsg { } export interface DataDocumentsMsg extends DataMsg { - result?: ElasticSearchHit[]; + result?: DataTableRecord[]; } export interface DataTotalHitsMsg extends DataMsg { diff --git a/src/plugins/discover/public/application/main/utils/calc_field_counts.test.ts b/src/plugins/discover/public/application/main/utils/calc_field_counts.test.ts index 2ed564194bd25..1534dbf6aad4d 100644 --- a/src/plugins/discover/public/application/main/utils/calc_field_counts.test.ts +++ b/src/plugins/discover/public/application/main/utils/calc_field_counts.test.ts @@ -8,19 +8,17 @@ import { calcFieldCounts } from './calc_field_counts'; import { indexPatternMock } from '../../../__mocks__/index_pattern'; -import { ElasticSearchHit } from '../../../types'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; describe('calcFieldCounts', () => { test('returns valid field count data', async () => { const rows = [ - { _id: 1, _source: { message: 'test1', bytes: 20 } }, - { _id: 2, _source: { name: 'test2', extension: 'jpg' } }, - ] as unknown as ElasticSearchHit[]; + { _id: '1', _index: 'test', _source: { message: 'test1', bytes: 20 } }, + { _id: '2', _index: 'test', _source: { name: 'test2', extension: 'jpg' } }, + ].map((row) => buildDataTableRecord(row)); const result = calcFieldCounts(rows, indexPatternMock); expect(result).toMatchInlineSnapshot(` Object { - "_index": 2, - "_score": 2, "bytes": 1, "extension": 1, "message": 1, @@ -30,14 +28,12 @@ describe('calcFieldCounts', () => { }); test('updates field count data', async () => { const rows = [ - { _id: 1, _source: { message: 'test1', bytes: 20 } }, - { _id: 2, _source: { name: 'test2', extension: 'jpg' } }, - ] as unknown as ElasticSearchHit[]; + { _id: '1', _index: 'test', _source: { message: 'test1', bytes: 20 } }, + { _id: '2', _index: 'test', _source: { name: 'test2', extension: 'jpg' } }, + ].map((row) => buildDataTableRecord(row)); const result = calcFieldCounts(rows, indexPatternMock); expect(result).toMatchInlineSnapshot(` Object { - "_index": 2, - "_score": 2, "bytes": 1, "extension": 1, "message": 1, diff --git a/src/plugins/discover/public/application/main/utils/calc_field_counts.ts b/src/plugins/discover/public/application/main/utils/calc_field_counts.ts index cf2b5d7a880b3..5112625ba12b9 100644 --- a/src/plugins/discover/public/application/main/utils/calc_field_counts.ts +++ b/src/plugins/discover/public/application/main/utils/calc_field_counts.ts @@ -6,20 +6,19 @@ * Side Public License, v 1. */ import { DataView } from '@kbn/data-views-plugin/public'; -import { flattenHit } from '@kbn/data-plugin/public'; -import { ElasticSearchHit } from '../../../types'; +import { DataTableRecord } from '../../../types'; /** * This function is calculating stats of the available fields, for usage in sidebar and sharing * Note that this values aren't displayed, but used for internal calculations */ -export function calcFieldCounts(rows?: ElasticSearchHit[], indexPattern?: DataView) { +export function calcFieldCounts(rows?: DataTableRecord[], indexPattern?: DataView) { const counts: Record = {}; if (!rows || !indexPattern) { return {}; } for (const hit of rows) { - const fields = Object.keys(flattenHit(hit, indexPattern, { includeIgnoredValues: true })); + const fields = Object.keys(hit.flattened); for (const fieldName of fields) { counts[fieldName] = (counts[fieldName] || 0) + 1; } diff --git a/src/plugins/discover/public/application/main/utils/fetch_all.test.ts b/src/plugins/discover/public/application/main/utils/fetch_all.test.ts index d372f921f9976..e33d931c571da 100644 --- a/src/plugins/discover/public/application/main/utils/fetch_all.test.ts +++ b/src/plugins/discover/public/application/main/utils/fetch_all.test.ts @@ -27,6 +27,8 @@ import { import { fetchDocuments } from './fetch_documents'; import { fetchChart } from './fetch_chart'; import { fetchTotalHits } from './fetch_total_hits'; +import { indexPatternMock } from '../../../__mocks__/index_pattern'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; jest.mock('./fetch_documents', () => ({ fetchDocuments: jest.fn().mockResolvedValue([]), @@ -119,7 +121,10 @@ describe('test fetchAll', () => { expect(await collect()).toEqual([ { fetchStatus: FetchStatus.UNINITIALIZED }, { fetchStatus: FetchStatus.LOADING }, - { fetchStatus: FetchStatus.COMPLETE, result: hits }, + { + fetchStatus: FetchStatus.COMPLETE, + result: hits.map((hit) => buildDataTableRecord(hit, indexPatternMock)), + }, ]); }); diff --git a/src/plugins/discover/public/application/main/utils/fetch_all.ts b/src/plugins/discover/public/application/main/utils/fetch_all.ts index 1d5d4646445a5..655027dddbf1e 100644 --- a/src/plugins/discover/public/application/main/utils/fetch_all.ts +++ b/src/plugins/discover/public/application/main/utils/fetch_all.ts @@ -5,11 +5,11 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { ISearchSource } from '@kbn/data-plugin/public'; +import { DataPublicPluginStart, ISearchSource } from '@kbn/data-plugin/public'; import { Adapters } from '@kbn/inspector-plugin'; -import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { ReduxLikeStateContainer } from '@kbn/kibana-utils-plugin/common'; import { DataViewType } from '@kbn/data-views-plugin/public'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; import { sendCompleteMsg, sendErrorMsg, @@ -45,6 +45,7 @@ export interface FetchDeps { services: DiscoverServices; useNewFieldsApi: boolean; } + /** * This function starts fetching all required queries in Discover. This will be the query to load the individual * documents, and depending on whether a chart is shown either the aggregation query to load the chart data @@ -139,10 +140,13 @@ export function fetchAll( result: docs.length, }); } + const dataView = searchSource.getField('index')!; + + const resultDocs = docs.map((doc) => buildDataTableRecord(doc, dataView)); dataSubjects.documents$.next({ fetchStatus: FetchStatus.COMPLETE, - result: docs, + result: resultDocs, }); checkHitCount(docs.length); diff --git a/src/plugins/discover/public/application/main/utils/fetch_chart.ts b/src/plugins/discover/public/application/main/utils/fetch_chart.ts index 5117bffe5c9b8..da1a071a18d4b 100644 --- a/src/plugins/discover/public/application/main/utils/fetch_chart.ts +++ b/src/plugins/discover/public/application/main/utils/fetch_chart.ts @@ -28,14 +28,7 @@ interface Result { export function fetchChart( searchSource: ISearchSource, - { - abortController, - appStateContainer, - data, - inspectorAdapters, - searchSessionId, - savedSearch, - }: FetchDeps + { abortController, appStateContainer, data, inspectorAdapters, searchSessionId }: FetchDeps ): Promise { const interval = appStateContainer.getState().interval ?? 'auto'; const chartAggConfigs = updateSearchSource(searchSource, interval, data); diff --git a/src/plugins/discover/public/application/main/utils/fetch_documents.ts b/src/plugins/discover/public/application/main/utils/fetch_documents.ts index d652f544a8f70..e09875d11deb6 100644 --- a/src/plugins/discover/public/application/main/utils/fetch_documents.ts +++ b/src/plugins/discover/public/application/main/utils/fetch_documents.ts @@ -18,7 +18,7 @@ import { FetchDeps } from './fetch_all'; */ export const fetchDocuments = ( searchSource: ISearchSource, - { abortController, inspectorAdapters, searchSessionId, services, savedSearch }: FetchDeps + { abortController, inspectorAdapters, searchSessionId, services }: FetchDeps ) => { searchSource.setField('size', services.uiSettings.get(SAMPLE_SIZE_SETTING)); searchSource.setField('trackTotalHits', false); diff --git a/src/plugins/discover/public/application/types.ts b/src/plugins/discover/public/application/types.ts index f04f3bf77c2f9..798e0f350cc5f 100644 --- a/src/plugins/discover/public/application/types.ts +++ b/src/plugins/discover/public/application/types.ts @@ -5,7 +5,6 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; export enum FetchStatus { UNINITIALIZED = 'uninitialized', @@ -14,13 +13,3 @@ export enum FetchStatus { COMPLETE = 'complete', ERROR = 'error', } - -export type EsHitRecord = Required< - Pick -> & { - _source?: Record; - _score?: number; - // note that this a special property for Discover Context, to determine the anchor record - isAnchor?: boolean; -}; -export type EsHitRecordList = EsHitRecord[]; diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid.test.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid.test.tsx index c5ac7335b69c2..876ffadfed433 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid.test.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid.test.tsx @@ -14,10 +14,11 @@ import { esHits } from '../../__mocks__/es_hits'; import { indexPatternMock } from '../../__mocks__/index_pattern'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { DiscoverGrid, DiscoverGridProps } from './discover_grid'; -import { getDocId } from './discover_grid_document_selection'; -import { ElasticSearchHit } from '../../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { discoverServiceMock } from '../../__mocks__/services'; +import { buildDataTableRecord } from '../../utils/build_data_record'; +import { getDocId } from '../../utils/get_doc_id'; +import { EsHitRecord } from '../../types'; function getProps() { return { @@ -32,7 +33,7 @@ function getProps() { onResize: jest.fn(), onSetColumns: jest.fn(), onSort: jest.fn(), - rows: esHits, + rows: esHits.map((hit) => buildDataTableRecord(hit, indexPatternMock)), sampleSize: 30, searchDescription: '', searchTitle: '', @@ -74,7 +75,7 @@ function getDisplayedDocNr(component: ReactWrapper) { async function toggleDocSelection( component: ReactWrapper, - document: ElasticSearchHit + document: EsHitRecord ) { act(() => { const docId = getDocId(document); @@ -146,7 +147,7 @@ describe('DiscoverGrid', () => { bytes: 50, }, }, - ], + ].map((row) => buildDataTableRecord(row, indexPatternMock)), }); expect(getDisplayedDocNr(component)).toBe(1); expect(getSelectedDocNr(component)).toBe(0); diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid.tsx index 48fd2ba656746..5b60a92110320 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid.tsx @@ -23,7 +23,6 @@ import { EuiLink, } from '@elastic/eui'; import type { DataView } from '@kbn/data-views-plugin/public'; -import { flattenHit } from '@kbn/data-plugin/public'; import { DocViewFilterFn } from '../../services/doc_views/doc_views_types'; import { getSchemaDetectors } from './discover_grid_schema'; import { DiscoverGridFlyout } from './discover_grid_flyout'; @@ -48,10 +47,10 @@ import { MAX_DOC_FIELDS_DISPLAYED, SHOW_MULTIFIELDS, } from '../../../common'; -import { DiscoverGridDocumentToolbarBtn, getDocId } from './discover_grid_document_selection'; +import { DiscoverGridDocumentToolbarBtn } from './discover_grid_document_selection'; import { SortPairArr } from '../doc_table/utils/get_sort'; import { getFieldsToShow } from '../../utils/get_fields_to_show'; -import type { ElasticSearchHit, ValueToStringConverter } from '../../types'; +import type { DataTableRecord, ValueToStringConverter } from '../../types'; import { useRowHeightsOptions } from '../../hooks/use_row_heights_options'; import { useDiscoverServices } from '../../hooks/use_discover_services'; import { convertValueToString } from '../../utils/convert_value_to_string'; @@ -77,7 +76,7 @@ export interface DiscoverGridProps { /** * If set, the given document is displayed in a flyout */ - expandedDoc?: ElasticSearchHit; + expandedDoc?: DataTableRecord; /** * The used index pattern */ @@ -114,7 +113,7 @@ export interface DiscoverGridProps { /** * Array of documents provided by Elasticsearch */ - rows?: ElasticSearchHit[]; + rows?: DataTableRecord[]; /** * The max size of the documents returned by Elasticsearch */ @@ -122,7 +121,7 @@ export interface DiscoverGridProps { /** * Function to set the expanded document, which is displayed in a flyout */ - setExpandedDoc: (doc?: ElasticSearchHit) => void; + setExpandedDoc: (doc?: DataTableRecord) => void; /** * Grid display settings persisted in Elasticsearch (e.g. column width) */ @@ -211,7 +210,7 @@ export const DiscoverGrid = ({ if (!selectedDocs.length || !rows?.length) { return []; } - const idMap = rows.reduce((map, row) => map.set(getDocId(row), true), new Map()); + const idMap = rows.reduce((map, row) => map.set(row.id, true), new Map()); // filter out selected docs that are no longer part of the current data const result = selectedDocs.filter((docId) => idMap.get(docId)); if (result.length === 0 && isFilterActive) { @@ -227,7 +226,7 @@ export const DiscoverGrid = ({ if (!isFilterActive || usedSelectedDocs.length === 0) { return rows; } - const rowsFiltered = rows.filter((row) => usedSelectedDocs.includes(getDocId(row))); + const rowsFiltered = rows.filter((row) => usedSelectedDocs.includes(row.id)); if (!rowsFiltered.length) { // in case the selected docs are no longer part of the sample of 500, show all docs return rows; @@ -235,25 +234,18 @@ export const DiscoverGrid = ({ return rowsFiltered; }, [rows, usedSelectedDocs, isFilterActive]); - const displayedRowsFlattened = useMemo(() => { - return displayedRows.map((hit) => { - return flattenHit(hit, indexPattern, { includeIgnoredValues: true }); - }); - }, [displayedRows, indexPattern]); - const valueToStringConverter: ValueToStringConverter = useCallback( (rowIndex, columnId, options) => { return convertValueToString({ rowIndex, rows: displayedRows, - rowsFlattened: displayedRowsFlattened, dataView: indexPattern, columnId, services, options, }); }, - [displayedRows, displayedRowsFlattened, indexPattern, services] + [displayedRows, indexPattern, services] ); /** @@ -314,20 +306,12 @@ export const DiscoverGrid = ({ getRenderCellValueFn( indexPattern, displayedRows, - displayedRowsFlattened, useNewFieldsApi, fieldsToShow, services.uiSettings.get(MAX_DOC_FIELDS_DISPLAYED), () => dataGridRef.current?.closeCellPopover() ), - [ - indexPattern, - displayedRowsFlattened, - displayedRows, - useNewFieldsApi, - fieldsToShow, - services.uiSettings, - ] + [indexPattern, displayedRows, useNewFieldsApi, fieldsToShow, services.uiSettings] ); /** @@ -473,7 +457,6 @@ export const DiscoverGrid = ({ expanded: expandedDoc, setExpanded: setExpandedDoc, rows: displayedRows, - rowsFlattened: displayedRowsFlattened, onFilter, indexPattern, isDarkMode: services.uiSettings.get('theme:darkMode'), diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_cell_actions.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_cell_actions.tsx index f7497dd5d459d..055967d6440a2 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_cell_actions.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_cell_actions.tsx @@ -20,8 +20,8 @@ function onFilterCell( columnId: EuiDataGridColumnCellActionProps['columnId'], mode: '+' | '-' ) { - const row = context.rowsFlattened[rowIndex]; - const value = String(row[columnId]); + const row = context.rows[rowIndex]; + const value = String(row.flattened[columnId]); const field = context.indexPattern.fields.getByName(columnId); if (value && field) { diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_context.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_context.tsx index ca2a0ee5839cb..0761e4c40376e 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_context.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_context.tsx @@ -9,13 +9,12 @@ import React from 'react'; import type { DataView } from '@kbn/data-views-plugin/public'; import type { DocViewFilterFn } from '../../services/doc_views/doc_views_types'; -import type { ElasticSearchHit, HitsFlattened, ValueToStringConverter } from '../../types'; +import type { DataTableRecord, ValueToStringConverter } from '../../types'; export interface GridContext { - expanded?: ElasticSearchHit; - setExpanded: (hit?: ElasticSearchHit) => void; - rows: ElasticSearchHit[]; - rowsFlattened: HitsFlattened; + expanded?: DataTableRecord | undefined; + setExpanded: (hit?: DataTableRecord) => void; + rows: DataTableRecord[]; onFilter: DocViewFilterFn; indexPattern: DataView; isDarkMode: boolean; diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.test.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.test.tsx index 5ca7b84789e91..96bc9082d9e0f 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.test.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.test.tsx @@ -8,13 +8,10 @@ import React from 'react'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { findTestSubject } from '@elastic/eui/lib/test'; -import { - DiscoverGridDocumentToolbarBtn, - getDocId, - SelectButton, -} from './discover_grid_document_selection'; +import { DiscoverGridDocumentToolbarBtn, SelectButton } from './discover_grid_document_selection'; import { discoverGridContextMock } from '../../__mocks__/grid_context'; import { DiscoverGridContext } from './discover_grid_context'; +import { getDocId } from '../../utils/get_doc_id'; describe('document selection', () => { describe('getDocId', () => { diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.tsx index efe8784028cbf..c17ff66ac0806 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_document_selection.tsx @@ -5,37 +5,28 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import React, { useCallback, useState, useContext, useMemo, useEffect } from 'react'; +import React, { useCallback, useContext, useEffect, useMemo, useState } from 'react'; import classNames from 'classnames'; import { EuiButtonEmpty, + EuiCheckbox, EuiContextMenuItem, EuiContextMenuPanel, EuiCopy, - EuiPopover, - EuiCheckbox, EuiDataGridCellValueElementProps, + EuiPopover, } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { euiLightVars as themeLight, euiDarkVars as themeDark } from '@kbn/ui-theme'; +import { euiDarkVars as themeDark, euiLightVars as themeLight } from '@kbn/ui-theme'; import { i18n } from '@kbn/i18n'; import { DiscoverGridContext } from './discover_grid_context'; -import { ElasticSearchHit } from '../../types'; +import type { DataTableRecord } from '../../types'; -/** - * Returning a generated id of a given ES document, since `_id` can be the same - * when using different indices and shard routing - */ -export const getDocId = (doc: ElasticSearchHit & { _routing?: string }) => { - const routing = doc._routing ? doc._routing : ''; - return [doc._index, doc._id, routing].join('::'); -}; export const SelectButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueElementProps) => { const { selectedDocs, expanded, rows, isDarkMode, setSelectedDocs } = useContext(DiscoverGridContext); const doc = useMemo(() => rows[rowIndex], [rows, rowIndex]); - const id = useMemo(() => getDocId(doc), [doc]); - const checked = useMemo(() => selectedDocs.includes(id), [selectedDocs, id]); + const checked = useMemo(() => selectedDocs.includes(doc.id), [selectedDocs, doc.id]); const toggleDocumentSelectionLabel = i18n.translate('discover.grid.selectDoc', { defaultMessage: `Select document '{rowNumber}'`, @@ -43,7 +34,7 @@ export const SelectButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueEle }); useEffect(() => { - if (expanded && doc && expanded._id === doc._id && expanded._index === doc._index) { + if (expanded && doc && expanded.id === doc.id) { setCellProps({ style: { backgroundColor: isDarkMode ? themeDark.euiColorHighlight : themeLight.euiColorHighlight, @@ -56,16 +47,16 @@ export const SelectButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueEle return ( { if (checked) { - const newSelection = selectedDocs.filter((docId) => docId !== id); + const newSelection = selectedDocs.filter((docId) => docId !== doc.id); setSelectedDocs(newSelection); } else { - setSelectedDocs([...selectedDocs, id]); + setSelectedDocs([...selectedDocs, doc.id]); } }} /> @@ -80,7 +71,7 @@ export function DiscoverGridDocumentToolbarBtn({ setSelectedDocs, }: { isFilterActive: boolean; - rows: ElasticSearchHit[]; + rows: DataTableRecord[]; selectedDocs: string[]; setIsFilterActive: (value: boolean) => void; setSelectedDocs: (value: string[]) => void; @@ -121,7 +112,11 @@ export function DiscoverGridDocumentToolbarBtn({ key="copyJsonWrapper" data-test-subj="dscGridCopySelectedDocumentsJSON" textToCopy={ - rows ? JSON.stringify(rows.filter((row) => selectedDocs.includes(getDocId(row)))) : '' + rows + ? JSON.stringify( + rows.filter((row) => selectedDocs.includes(row.id)).map((row) => row.raw) + ) + : '' } > {(copy) => ( diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_expand_button.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_expand_button.tsx index 3a506c063c177..e00e722f9c2e9 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_expand_button.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_expand_button.tsx @@ -11,7 +11,6 @@ import { EuiButtonIcon, EuiDataGridCellValueElementProps, EuiToolTip } from '@el import { euiLightVars as themeLight, euiDarkVars as themeDark } from '@kbn/ui-theme'; import { i18n } from '@kbn/i18n'; import { DiscoverGridContext } from './discover_grid_context'; -import { EsHitRecord } from '../../application/types'; import { DISCOVER_TOUR_STEP_ANCHOR_IDS } from '../discover_tour'; /** @@ -21,16 +20,11 @@ export const ExpandButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueEle const { expanded, setExpanded, rows, isDarkMode } = useContext(DiscoverGridContext); const current = rows[rowIndex]; useEffect(() => { - if ((current as EsHitRecord).isAnchor) { + if (current.isAnchor) { setCellProps({ className: 'dscDocsGrid__cell--highlight', }); - } else if ( - expanded && - current && - expanded._id === current._id && - expanded._index === current._index - ) { + } else if (expanded && current && expanded.id === current.id) { setCellProps({ style: { backgroundColor: isDarkMode ? themeDark.euiColorHighlight : themeLight.euiColorHighlight, @@ -46,7 +40,7 @@ export const ExpandButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueEle defaultMessage: 'Toggle dialog with details', }); - const testSubj = (current as EsHitRecord).isAnchor + const testSubj = current.isAnchor ? 'docTableExpandToggleColumnAnchor' : 'docTableExpandToggleColumn'; diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.test.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.test.tsx index 6452349bbdc77..5b4d4d3109e19 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.test.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.test.tsx @@ -19,7 +19,8 @@ import { setDocViewsRegistry } from '../../kibana_services'; import { indexPatternWithTimefieldMock } from '../../__mocks__/index_pattern_with_timefield'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; -import type { ElasticSearchHit } from '../../types'; +import type { DataTableRecord, EsHitRecord } from '../../types'; +import { buildDataTableRecord } from '../../utils/build_data_record'; describe('Discover flyout', function () { setDocViewsRegistry(new DocViewsRegistry()); @@ -30,7 +31,7 @@ describe('Discover flyout', function () { hitIndex, }: { indexPattern?: DataView; - hits?: ElasticSearchHit[]; + hits?: DataTableRecord[]; hitIndex?: number; }) => { const onClose = jest.fn(); @@ -40,11 +41,20 @@ describe('Discover flyout', function () { history: () => ({ location: {} }), } as unknown as DiscoverServices; + const hit = buildDataTableRecord( + hitIndex ? esHits[hitIndex] : (esHits[0] as EsHitRecord), + indexPatternMock + ); + const props = { columns: ['date'], indexPattern: indexPattern || indexPatternMock, - hit: hitIndex ? esHits[hitIndex] : esHits[0], - hits: hits || esHits, + hit, + hits: + hits || + esHits.map((entry: EsHitRecord) => + buildDataTableRecord(entry, indexPattern || indexPatternMock) + ), onAddColumn: jest.fn(), onClose, onFilter: jest.fn(), @@ -116,7 +126,7 @@ describe('Discover flyout', function () { _type: '_doc', _source: { date: '2020-20-01T12:12:12.124', name: 'test2', extension: 'jpg' }, }, - ]; + ].map((hit) => buildDataTableRecord(hit, indexPatternMock)); const { component } = mountComponent({ hits }); const docNav = findTestSubject(component, 'dscDocNavigation'); expect(docNav.length).toBeFalsy(); @@ -127,7 +137,7 @@ describe('Discover flyout', function () { const { component, props } = mountComponent({}); findTestSubject(component, 'pagination-button-next').simulate('click'); // we selected 1, so we'd expect 2 - expect(props.setExpandedDoc.mock.calls[0][0]._id).toBe('2'); + expect(props.setExpandedDoc.mock.calls[0][0].raw._id).toBe('2'); }); it('doesnt allow you to navigate to the previous doc, if expanded doc is the first', async () => { @@ -149,16 +159,16 @@ describe('Discover flyout', function () { const { component, props } = mountComponent({ hitIndex: esHits.length - 1 }); findTestSubject(component, 'pagination-button-previous').simulate('click'); expect(props.setExpandedDoc).toHaveBeenCalledTimes(1); - expect(props.setExpandedDoc.mock.calls[0][0]._id).toBe('4'); + expect(props.setExpandedDoc.mock.calls[0][0].raw._id).toBe('4'); }); it('allows navigating with arrow keys through documents', () => { const { component, props } = mountComponent({}); findTestSubject(component, 'docTableDetailsFlyout').simulate('keydown', { key: 'ArrowRight' }); - expect(props.setExpandedDoc).toHaveBeenCalledWith(expect.objectContaining({ _id: '2' })); + expect(props.setExpandedDoc).toHaveBeenCalledWith(expect.objectContaining({ id: 'i::2::' })); component.setProps({ ...props, hit: props.hits[1] }); findTestSubject(component, 'docTableDetailsFlyout').simulate('keydown', { key: 'ArrowLeft' }); - expect(props.setExpandedDoc).toHaveBeenCalledWith(expect.objectContaining({ _id: '1' })); + expect(props.setExpandedDoc).toHaveBeenCalledWith(expect.objectContaining({ id: 'i::1::' })); }); it('should not navigate with keypresses when already at the border of documents', () => { diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.tsx index a34e6da654699..c2165fc27ee2a 100644 --- a/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.tsx +++ b/src/plugins/discover/public/components/discover_grid/discover_grid_flyout.tsx @@ -28,31 +28,24 @@ import { import { DocViewer } from '../../services/doc_views/components/doc_viewer/doc_viewer'; import { DocViewFilterFn } from '../../services/doc_views/doc_views_types'; import { useNavigationProps } from '../../hooks/use_navigation_props'; -import { ElasticSearchHit } from '../../types'; import { useDiscoverServices } from '../../hooks/use_discover_services'; +import type { DataTableRecord } from '../../types'; export interface DiscoverGridFlyoutProps { columns: string[]; - hit: ElasticSearchHit; - hits?: ElasticSearchHit[]; + hit: DataTableRecord; + hits?: DataTableRecord[]; indexPattern: DataView; onAddColumn: (column: string) => void; onClose: () => void; onFilter: DocViewFilterFn; onRemoveColumn: (column: string) => void; - setExpandedDoc: (doc: ElasticSearchHit) => void; + setExpandedDoc: (doc: DataTableRecord) => void; } -type ElasticSearchHitWithRouting = ElasticSearchHit & { _routing?: string }; - -function getDocFingerprintId(doc: ElasticSearchHitWithRouting) { - const routing = doc._routing || ''; - return [doc._index, doc._id, routing].join('||'); -} - -function getIndexByDocId(hits: ElasticSearchHit[], id: string) { +function getIndexByDocId(hits: DataTableRecord[], id: string) { return hits.findIndex((h) => { - return getDocFingerprintId(h) === id; + return h.id === id; }); } /** @@ -71,13 +64,10 @@ export function DiscoverGridFlyout({ }: DiscoverGridFlyoutProps) { const services = useDiscoverServices(); // Get actual hit with updated highlighted searches - const actualHit = useMemo( - () => hits?.find(({ _id, _index }) => hit._index === _index && _id === hit?._id) || hit, - [hit, hits] - ); + const actualHit = useMemo(() => hits?.find(({ id }) => id === hit?.id) || hit, [hit, hits]); const pageCount = useMemo(() => (hits ? hits.length : 0), [hits]); const activePage = useMemo(() => { - const id = getDocFingerprintId(hit); + const id = hit.id; if (!hits || pageCount <= 1) { return -1; } @@ -107,8 +97,8 @@ export function DiscoverGridFlyout({ const { singleDocProps, surrDocsProps } = useNavigationProps({ indexPatternId: indexPattern.id!, - rowIndex: hit._index, - rowId: hit._id, + rowIndex: hit.raw._index, + rowId: hit.raw._id, filterManager: services.filterManager, addBasePath: services.addBasePath, columns, diff --git a/src/plugins/discover/public/components/discover_grid/get_render_cell_value.test.tsx b/src/plugins/discover/public/components/discover_grid/get_render_cell_value.test.tsx index c706892c9f706..b797c8a969831 100644 --- a/src/plugins/discover/public/components/discover_grid/get_render_cell_value.test.tsx +++ b/src/plugins/discover/public/components/discover_grid/get_render_cell_value.test.tsx @@ -12,9 +12,9 @@ import { findTestSubject } from '@elastic/eui/lib/test'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { getRenderCellValueFn } from './get_render_cell_value'; import { indexPatternMock } from '../../__mocks__/index_pattern'; -import { flattenHit } from '@kbn/data-plugin/public'; -import { ElasticSearchHit } from '../../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { buildDataTableRecord } from '../../utils/build_data_record'; +import { EsHitRecord } from '../../types'; const mockServices = { uiSettings: { @@ -33,7 +33,7 @@ jest.mock('../../hooks/use_discover_services', () => { }; }); -const rowsSource: ElasticSearchHit[] = [ +const rowsSource: EsHitRecord[] = [ { _id: '1', _index: 'test', @@ -45,7 +45,7 @@ const rowsSource: ElasticSearchHit[] = [ }, ]; -const rowsFields: ElasticSearchHit[] = [ +const rowsFields: EsHitRecord[] = [ { _id: '1', _index: 'test', @@ -58,7 +58,7 @@ const rowsFields: ElasticSearchHit[] = [ }, ]; -const rowsFieldsWithTopLevelObject: ElasticSearchHit[] = [ +const rowsFieldsWithTopLevelObject: EsHitRecord[] = [ { _id: '1', _index: 'test', @@ -71,16 +71,13 @@ const rowsFieldsWithTopLevelObject: ElasticSearchHit[] = [ }, ]; -const flatten = (hit: ElasticSearchHit): Record => { - return flattenHit(hit, indexPatternMock); -}; +const build = (hit: EsHitRecord) => buildDataTableRecord(hit, indexPatternMock); describe('Discover grid cell rendering', function () { it('renders bytes column correctly', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, [], 100, @@ -105,8 +102,7 @@ describe('Discover grid cell rendering', function () { it('renders bytes column correctly using _source when details is true', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, [], 100, @@ -132,8 +128,7 @@ describe('Discover grid cell rendering', function () { const closePopoverMockFn = jest.fn(); const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFields, - rowsFields.map(flatten), + rowsFields.map(build), false, [], 100, @@ -160,8 +155,7 @@ describe('Discover grid cell rendering', function () { it('renders _source column correctly', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, ['extension', 'bytes'], 100, @@ -235,8 +229,7 @@ describe('Discover grid cell rendering', function () { it('renders _source column correctly when isDetails is set to true', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, [], 100, @@ -309,8 +302,7 @@ describe('Discover grid cell rendering', function () { it('renders fields-based column correctly', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFields, - rowsFields.map(flatten), + rowsFields.map(build), true, ['extension', 'bytes'], 100, @@ -388,8 +380,7 @@ describe('Discover grid cell rendering', function () { it('limits amount of rendered items', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFields, - rowsFields.map(flatten), + rowsFields.map(build), true, ['extension', 'bytes'], // this is the number of rendered items @@ -468,8 +459,7 @@ describe('Discover grid cell rendering', function () { it('renders fields-based column correctly when isDetails is set to true', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFields, - rowsFields.map(flatten), + rowsFields.map(build), true, [], 100, @@ -547,8 +537,7 @@ describe('Discover grid cell rendering', function () { it('collect object fields and renders them like _source', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsWithTopLevelObject, - rowsFieldsWithTopLevelObject.map(flatten), + rowsFieldsWithTopLevelObject.map(build), true, ['object.value', 'extension', 'bytes'], 100, @@ -590,8 +579,7 @@ describe('Discover grid cell rendering', function () { (indexPatternMock.getFieldByName as jest.Mock).mockReturnValueOnce(undefined); const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsWithTopLevelObject, - rowsFieldsWithTopLevelObject.map(flatten), + rowsFieldsWithTopLevelObject.map(build), true, ['extension', 'bytes', 'object.value'], 100, @@ -633,8 +621,7 @@ describe('Discover grid cell rendering', function () { const closePopoverMockFn = jest.fn(); const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsWithTopLevelObject, - rowsFieldsWithTopLevelObject.map(flatten), + rowsFieldsWithTopLevelObject.map(build), true, [], 100, @@ -699,8 +686,7 @@ describe('Discover grid cell rendering', function () { const closePopoverMockFn = jest.fn(); const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsWithTopLevelObject, - rowsFieldsWithTopLevelObject.map(flatten), + rowsFieldsWithTopLevelObject.map(build), true, [], 100, @@ -728,8 +714,7 @@ describe('Discover grid cell rendering', function () { (indexPatternMock.getFieldByName as jest.Mock).mockReturnValueOnce(undefined); const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsWithTopLevelObject, - rowsFieldsWithTopLevelObject.map(flatten), + rowsFieldsWithTopLevelObject.map(build), true, [], 100, @@ -763,8 +748,7 @@ describe('Discover grid cell rendering', function () { it('renders correctly when invalid row is given', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, [], 100, @@ -789,8 +773,7 @@ describe('Discover grid cell rendering', function () { it('renders correctly when invalid column is given', () => { const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsSource, - rowsSource.map(flatten), + rowsSource.map(build), false, [], 100, @@ -814,7 +797,7 @@ describe('Discover grid cell rendering', function () { it('renders unmapped fields correctly', () => { (indexPatternMock.getFieldByName as jest.Mock).mockReturnValueOnce(undefined); - const rowsFieldsUnmapped: ElasticSearchHit[] = [ + const rowsFieldsUnmapped: EsHitRecord[] = [ { _id: '1', _index: 'test', @@ -828,8 +811,7 @@ describe('Discover grid cell rendering', function () { ]; const DiscoverGridCellValue = getRenderCellValueFn( indexPatternMock, - rowsFieldsUnmapped, - rowsFieldsUnmapped.map(flatten), + rowsFieldsUnmapped.map(build), true, ['unmapped'], 100, diff --git a/src/plugins/discover/public/components/discover_grid/get_render_cell_value.tsx b/src/plugins/discover/public/components/discover_grid/get_render_cell_value.tsx index b129b57dbec9c..5636e31efff5c 100644 --- a/src/plugins/discover/public/components/discover_grid/get_render_cell_value.tsx +++ b/src/plugins/discover/public/components/discover_grid/get_render_cell_value.tsx @@ -24,10 +24,9 @@ import { FieldFormatsStart } from '@kbn/field-formats-plugin/public'; import { DiscoverGridContext } from './discover_grid_context'; import { JsonCodeEditor } from '../json_code_editor/json_code_editor'; import { defaultMonacoEditorWidth } from './constants'; -import { EsHitRecord } from '../../application/types'; import { formatFieldValue } from '../../utils/format_value'; import { formatHit } from '../../utils/format_hit'; -import { ElasticSearchHit, HitsFlattened } from '../../types'; +import { DataTableRecord, EsHitRecord } from '../../types'; import { useDiscoverServices } from '../../hooks/use_discover_services'; import { MAX_DOC_FIELDS_DISPLAYED } from '../../../common'; @@ -36,8 +35,7 @@ const CELL_CLASS = 'dscDiscoverGrid__cellValue'; export const getRenderCellValueFn = ( dataView: DataView, - rows: ElasticSearchHit[] | undefined, - rowsFlattened: HitsFlattened, + rows: DataTableRecord[] | undefined, useNewFieldsApi: boolean, fieldsToShow: string[], maxDocFieldsDisplayed: number, @@ -49,24 +47,16 @@ export const getRenderCellValueFn = const maxEntries = useMemo(() => uiSettings.get(MAX_DOC_FIELDS_DISPLAYED), [uiSettings]); const row = rows ? rows[rowIndex] : undefined; - const rowFlattened = rowsFlattened - ? (rowsFlattened[rowIndex] as Record) - : undefined; const field = dataView.fields.getByName(columnId); const ctx = useContext(DiscoverGridContext); useEffect(() => { - if ((row as EsHitRecord).isAnchor) { + if (row?.isAnchor) { setCellProps({ className: 'dscDocsGrid__cell--highlight', }); - } else if ( - ctx.expanded && - row && - ctx.expanded._id === row._id && - ctx.expanded._index === row._index - ) { + } else if (ctx.expanded && row && ctx.expanded.id === row.id) { setCellProps({ style: { backgroundColor: ctx.isDarkMode @@ -79,7 +69,7 @@ export const getRenderCellValueFn = } }, [ctx, row, setCellProps]); - if (typeof row === 'undefined' || typeof rowFlattened === 'undefined') { + if (typeof row === 'undefined') { return -; } @@ -90,14 +80,13 @@ export const getRenderCellValueFn = const useTopLevelObjectColumns = Boolean( useNewFieldsApi && !field && - row?.fields && - !(row.fields as Record)[columnId] + row?.raw.fields && + !(row.raw.fields as Record)[columnId] ); if (isDetails) { return renderPopoverContent({ - rowRaw: row, - rowFlattened, + row, field, columnId, dataView, @@ -109,7 +98,7 @@ export const getRenderCellValueFn = if (field?.type === '_source' || useTopLevelObjectColumns) { const pairs = useTopLevelObjectColumns - ? getTopLevelObjectPairs(row, columnId, dataView, fieldsToShow).slice( + ? getTopLevelObjectPairs(row.raw, columnId, dataView, fieldsToShow).slice( 0, maxDocFieldsDisplayed ) @@ -140,7 +129,7 @@ export const getRenderCellValueFn = // formatFieldValue guarantees sanitized values // eslint-disable-next-line react/no-danger dangerouslySetInnerHTML={{ - __html: formatFieldValue(rowFlattened[columnId], row, fieldFormats, dataView, field), + __html: formatFieldValue(row.flattened[columnId], row.raw, fieldFormats, dataView, field), }} /> ); @@ -158,10 +147,10 @@ function getInnerColumns(fields: Record, columnId: string) { ); } -function getJSON(columnId: string, rowRaw: ElasticSearchHit, useTopLevelObjectColumns: boolean) { +function getJSON(columnId: string, row: DataTableRecord, useTopLevelObjectColumns: boolean) { const json = useTopLevelObjectColumns - ? getInnerColumns(rowRaw.fields as Record, columnId) - : rowRaw; + ? getInnerColumns(row.raw.fields as Record, columnId) + : row.raw; return json as Record; } @@ -169,8 +158,7 @@ function getJSON(columnId: string, rowRaw: ElasticSearchHit, useTopLevelObjectCo * Helper function for the cell popover */ function renderPopoverContent({ - rowRaw, - rowFlattened, + row, field, columnId, dataView, @@ -178,8 +166,7 @@ function renderPopoverContent({ fieldFormats, closePopover, }: { - rowRaw: ElasticSearchHit; - rowFlattened: Record; + row: DataTableRecord; field: DataViewField | undefined; columnId: string; dataView: DataView; @@ -209,7 +196,7 @@ function renderPopoverContent({ @@ -226,7 +213,13 @@ function renderPopoverContent({ // formatFieldValue guarantees sanitized values // eslint-disable-next-line react/no-danger dangerouslySetInnerHTML={{ - __html: formatFieldValue(rowFlattened[columnId], rowRaw, fieldFormats, dataView, field), + __html: formatFieldValue( + row.flattened[columnId], + row.raw, + fieldFormats, + dataView, + field + ), }} /> @@ -239,7 +232,7 @@ function renderPopoverContent({ * this is used for legacy stuff like displaying products of our ecommerce dataset */ function getTopLevelObjectPairs( - row: ElasticSearchHit, + row: EsHitRecord, columnId: string, dataView: DataView, fieldsToShow: string[] diff --git a/src/plugins/discover/public/components/doc_table/components/table_row.test.tsx b/src/plugins/discover/public/components/doc_table/components/table_row.test.tsx index 03a12428569f7..1101c01784e84 100644 --- a/src/plugins/discover/public/components/doc_table/components/table_row.test.tsx +++ b/src/plugins/discover/public/components/doc_table/components/table_row.test.tsx @@ -17,6 +17,8 @@ import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { discoverServiceMock } from '../../../__mocks__/services'; import { DOC_HIDE_TIME_COLUMN_SETTING, MAX_DOC_FIELDS_DISPLAYED } from '../../../../common'; +import { buildDataTableRecord } from '../../../utils/build_data_record'; +import { EsHitRecord } from '../../../types'; jest.mock('../utils/row_formatter', () => { const originalModule = jest.requireActual('../utils/row_formatter'); @@ -64,7 +66,7 @@ const mockHit = { }, ], _source: { message: 'mock_message', bytes: 20 }, -}; +} as unknown as EsHitRecord; const mockFilterManager = createFilterManagerMock(); @@ -74,7 +76,7 @@ describe('Doc table row component', () => { columns: ['_source'], filter: mockInlineFilter, indexPattern: indexPatternWithTimefieldMock, - row: mockHit, + row: buildDataTableRecord(mockHit, indexPatternWithTimefieldMock), useNewFieldsApi: true, filterManager: mockFilterManager, addBasePath: (path: string) => path, diff --git a/src/plugins/discover/public/components/doc_table/components/table_row.tsx b/src/plugins/discover/public/components/doc_table/components/table_row.tsx index e08843006020a..898cb25417403 100644 --- a/src/plugins/discover/public/components/doc_table/components/table_row.tsx +++ b/src/plugins/discover/public/components/doc_table/components/table_row.tsx @@ -10,7 +10,6 @@ import React, { Fragment, useCallback, useMemo, useState } from 'react'; import classNames from 'classnames'; import { i18n } from '@kbn/i18n'; import { EuiButtonEmpty, EuiIcon } from '@elastic/eui'; -import { flattenHit } from '@kbn/data-plugin/public'; import { DataView } from '@kbn/data-views-plugin/public'; import { formatFieldValue } from '../../../utils/format_value'; import { DocViewer } from '../../../services/doc_views/components/doc_viewer'; @@ -18,19 +17,19 @@ import { TableCell } from './table_row/table_cell'; import { formatRow, formatTopLevelObject } from '../utils/row_formatter'; import { useNavigationProps } from '../../../hooks/use_navigation_props'; import { DocViewFilterFn } from '../../../services/doc_views/doc_views_types'; -import { ElasticSearchHit } from '../../../types'; +import { DataTableRecord, EsHitRecord } from '../../../types'; import { TableRowDetails } from './table_row_details'; import { useDiscoverServices } from '../../../hooks/use_discover_services'; import { DOC_HIDE_TIME_COLUMN_SETTING, MAX_DOC_FIELDS_DISPLAYED } from '../../../../common'; -export type DocTableRow = ElasticSearchHit & { +export type DocTableRow = EsHitRecord & { isAnchor?: boolean; }; export interface TableRowProps { columns: string[]; filter: DocViewFilterFn; - row: DocTableRow; + row: DataTableRecord; indexPattern: DataView; useNewFieldsApi: boolean; fieldsToShow: string[]; @@ -62,10 +61,6 @@ export const TableRow = ({ }); const anchorDocTableRowSubj = row.isAnchor ? ' docTableAnchorRow' : ''; - const flattenedRow = useMemo( - () => flattenHit(row, indexPattern, { includeIgnoredValues: true }), - [indexPattern, row] - ); const mapping = useMemo(() => indexPattern.fields.getByName, [indexPattern]); // toggle display of the rows details, a full list of the fields from each row @@ -82,8 +77,8 @@ export const TableRow = ({ } const formattedField = formatFieldValue( - flattenedRow[fieldName], - row, + row.flattened[fieldName], + row.raw, fieldFormats, indexPattern, mapping(fieldName) @@ -98,15 +93,15 @@ export const TableRow = ({ const inlineFilter = useCallback( (column: string, type: '+' | '-') => { const field = indexPattern.fields.getByName(column); - filter(field!, flattenedRow[column], type); + filter(field!, row.flattened, type); }, - [filter, flattenedRow, indexPattern.fields] + [filter, indexPattern.fields, row.flattened] ); const { singleDocProps, surrDocsProps } = useNavigationProps({ indexPatternId: indexPattern.id!, - rowIndex: row._index, - rowId: row._id, + rowIndex: row.raw._index, + rowId: row.raw._id, filterManager, addBasePath, columns, @@ -161,9 +156,9 @@ export const TableRow = ({ ); } else { columns.forEach(function (column: string) { - if (useNewFieldsApi && !mapping(column) && row.fields && !row.fields[column]) { + if (useNewFieldsApi && !mapping(column) && row.raw.fields && !row.raw.fields[column]) { const innerColumns = Object.fromEntries( - Object.entries(row.fields).filter(([key]) => { + Object.entries(row.raw.fields).filter(([key]) => { return key.indexOf(`${column}.`) === 0; }) ); @@ -185,7 +180,7 @@ export const TableRow = ({ // We should improve this and show a helpful tooltip why the filter buttons are not // there/disabled when there are ignored values. const isFilterable = Boolean( - mapping(column)?.filterable && filter && !row._ignored?.includes(column) + mapping(column)?.filterable && filter && !row.raw._ignored?.includes(column) ); rowCells.push( { - const mountComponent = (rows?: DocTableRow[]) => { + const mountComponent = (rows?: EsHitRecord[]) => { const props = { columns: ['_source'], indexPattern: indexPatternMock, - rows: rows || [ - { - _index: 'mock_index', - _id: '1', - _score: 1, - fields: [ - { - timestamp: '2020-20-01T12:12:12.123', - }, - ], - _source: { message: 'mock_message', bytes: 20 }, - }, - ], + rows: ( + rows || [ + { + _index: 'mock_index', + _id: '1', + _score: 1, + fields: [ + { + timestamp: '2020-20-01T12:12:12.123', + }, + ], + _source: { message: 'mock_message', bytes: 20 }, + } as EsHitRecord, + ] + ).map((row) => buildDataTableRecord(row, indexPatternMock)), + sort: [['order_date', 'desc']], isLoading: false, searchDescription: '', diff --git a/src/plugins/discover/public/components/doc_table/doc_table_wrapper.tsx b/src/plugins/discover/public/components/doc_table/doc_table_wrapper.tsx index 3562337961417..e226c859fb0a1 100644 --- a/src/plugins/discover/public/components/doc_table/doc_table_wrapper.tsx +++ b/src/plugins/discover/public/components/doc_table/doc_table_wrapper.tsx @@ -13,16 +13,17 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { TableHeader } from './components/table_header/table_header'; import { SHOW_MULTIFIELDS } from '../../../common'; import { SortOrder } from './components/table_header/helpers'; -import { DocTableRow, TableRow } from './components/table_row'; +import { TableRow } from './components/table_row'; import { DocViewFilterFn } from '../../services/doc_views/doc_views_types'; import { getFieldsToShow } from '../../utils/get_fields_to_show'; import { useDiscoverServices } from '../../hooks/use_discover_services'; +import type { DataTableRecord } from '../../types'; export interface DocTableProps { /** * Rows of classic table */ - rows: DocTableRow[]; + rows: DataTableRecord[]; /** * Columns of classic table */ @@ -79,8 +80,8 @@ export interface DocTableProps { export interface DocTableRenderProps { columnLength: number; - rows: DocTableRow[]; - renderRows: (row: DocTableRow[]) => JSX.Element[]; + rows: DataTableRecord[]; + renderRows: (row: DataTableRecord[]) => JSX.Element[]; renderHeader: () => JSX.Element; onSkipBottomButtonClick: () => void; } @@ -155,10 +156,10 @@ export const DocTableWrapper = forwardRef( ); const renderRows = useCallback( - (rowsToRender: DocTableRow[]) => { + (rowsToRender: DataTableRecord[]) => { return rowsToRender.map((current) => ( { - const hit = { - _id: 'a', - _index: 'foo', - _type: 'doc', - _score: 1, - _source: { - foo: 'bar', - number: 42, - hello: '

World

', - also: 'with "quotes" or \'single quotes\'', - }, - }; let services: DiscoverServices; const createIndexPattern = () => { @@ -45,6 +34,18 @@ describe('Row formatter', () => { }; const indexPattern = createIndexPattern(); + const rawHit = { + _id: 'a', + _index: 'foo', + _score: 1, + _source: { + foo: 'bar', + number: 42, + hello: '

World

', + also: 'with "quotes" or \'single quotes\'', + }, + }; + const hit = buildDataTableRecord(rawHit, indexPattern); const fieldsToShow = indexPattern.fields.getAll().map((fld) => fld.name); @@ -138,15 +139,13 @@ describe('Row formatter', () => { }); it('formats document with highlighted fields first', () => { - expect( - formatRow( - { ...hit, highlight: { number: ['42'] } }, - indexPattern, - fieldsToShow, - 100, - services.fieldFormats - ) - ).toMatchInlineSnapshot(` + const highLightHit = buildDataTableRecord( + { ...rawHit, highlight: { number: ['42'] } }, + indexPattern + ); + + expect(formatRow(highLightHit, indexPattern, fieldsToShow, 100, services.fieldFormats)) + .toMatchInlineSnapshot(` { }; export const formatRow = ( - hit: estypes.SearchHit, + hit: DataTableRecord, indexPattern: DataView, fieldsToShow: string[], maxEntries: number, @@ -65,7 +65,7 @@ export const formatTopLevelObject = ( const displayKey = fields.getByName ? fields.getByName(key)?.displayName : undefined; const formatter = field ? indexPattern.getFormatterForField(field) - : { convert: (v: unknown, ...rest: unknown[]) => String(v) }; + : { convert: (v: unknown, ..._: unknown[]) => String(v) }; if (!values.map) return; const formatted = values .map((val: unknown) => diff --git a/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx b/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx index 0cd179768df0a..cc6557e50e668 100644 --- a/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx +++ b/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx @@ -27,6 +27,8 @@ import { ISearchSource } from '@kbn/data-plugin/public'; import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; import { KibanaContextProvider, KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; +import { buildDataTableRecord } from '../utils/build_data_record'; +import { DataTableRecord } from '../types'; import { ISearchEmbeddable, SearchInput, SearchOutput } from './types'; import { SavedSearch } from '../services/saved_searches'; import { SEARCH_EMBEDDABLE_TYPE } from './constants'; @@ -50,7 +52,6 @@ import { SortOrder } from '../components/doc_table/components/table_header/helpe import { VIEW_MODE } from '../components/view_mode_toggle'; import { updateSearchSource } from './utils/update_search_source'; import { FieldStatisticsTable } from '../application/main/components/field_stats_table'; -import { ElasticSearchHit } from '../types'; export type SearchProps = Partial & Partial & { @@ -59,9 +60,8 @@ export type SearchProps = Partial & sharedItemTitle?: string; inspectorAdapters?: Adapters; services: DiscoverServices; - filter?: (field: DataViewField, value: string[], operator: string) => void; - hits?: ElasticSearchHit[]; + hits?: DataTableRecord[]; totalHitCount?: number; onMoveColumn?: (column: string, index: number) => void; onUpdateRowHeight?: (rowHeight?: number) => void; @@ -131,12 +131,15 @@ export class SavedSearchEmbeddable this.inspectorAdapters = { requests: new RequestAdapter(), }; + this.panelTitle = savedSearch.title ?? ''; this.initializeSearchEmbeddableProps(); this.subscription = this.getUpdated$().subscribe(() => { - this.panelTitle = this.output.title || ''; - - if (this.searchProps) { + const titleChanged = this.output.title && this.panelTitle !== this.output.title; + if (titleChanged) { + this.panelTitle = this.output.title || ''; + } + if (this.searchProps && (titleChanged || this.isFetchRequired(this.searchProps))) { this.pushContainerStateParamsToProps(this.searchProps); } }); @@ -207,7 +210,9 @@ export class SavedSearchEmbeddable ); this.updateOutput({ loading: false, error: undefined }); - this.searchProps!.rows = resp.hits.hits; + this.searchProps!.rows = resp.hits.hits.map((hit) => + buildDataTableRecord(hit, this.searchProps!.indexPattern) + ); this.searchProps!.totalHitCount = resp.hits.total as number; this.searchProps!.isLoading = false; } catch (error) { @@ -329,16 +334,24 @@ export class SavedSearchEmbeddable } } - private async pushContainerStateParamsToProps( - searchProps: SearchProps, - { forceFetch = false }: { forceFetch: boolean } = { forceFetch: false } - ) { - const isFetchRequired = + private isFetchRequired(searchProps?: SearchProps) { + if (!searchProps) { + return false; + } + return ( !onlyDisabledFiltersChanged(this.input.filters, this.prevFilters) || !isEqual(this.prevQuery, this.input.query) || !isEqual(this.prevTimeRange, this.input.timeRange) || !isEqual(searchProps.sort, this.input.sort || this.savedSearch.sort) || - this.prevSearchSessionId !== this.input.searchSessionId; + this.prevSearchSessionId !== this.input.searchSessionId + ); + } + + private async pushContainerStateParamsToProps( + searchProps: SearchProps, + { forceFetch = false }: { forceFetch: boolean } = { forceFetch: false } + ) { + const isFetchRequired = this.isFetchRequired(searchProps); // If there is column or sort data on the panel, that means the original columns or sort settings have // been overridden in a dashboard. @@ -393,7 +406,7 @@ export class SavedSearchEmbeddable } private renderReactComponent(domNode: HTMLElement, searchProps: SearchProps) { - if (!this.searchProps) { + if (!searchProps) { return; } diff --git a/src/plugins/discover/public/embeddable/saved_search_grid.tsx b/src/plugins/discover/public/embeddable/saved_search_grid.tsx index ff72ed378aff3..7c567dc75dfa3 100644 --- a/src/plugins/discover/public/embeddable/saved_search_grid.tsx +++ b/src/plugins/discover/public/embeddable/saved_search_grid.tsx @@ -7,9 +7,9 @@ */ import React, { useState, memo } from 'react'; import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; +import { DataTableRecord } from '../types'; import { DiscoverGrid, DiscoverGridProps } from '../components/discover_grid/discover_grid'; import { TotalDocuments } from '../application/main/components/total_documents/total_documents'; -import { ElasticSearchHit } from '../types'; export interface DiscoverGridEmbeddableProps extends DiscoverGridProps { totalHitCount: number; @@ -18,7 +18,7 @@ export interface DiscoverGridEmbeddableProps extends DiscoverGridProps { export const DataGridMemoized = memo(DiscoverGrid); export function DiscoverGridEmbeddable(props: DiscoverGridEmbeddableProps) { - const [expandedDoc, setExpandedDoc] = useState(undefined); + const [expandedDoc, setExpandedDoc] = useState(undefined); return ( helper / hook', () => { getComputedFields: () => [], }; - const record = { test: 1 }; + const record = { _id: '1', _index: 't', test: 1 }; const props = { id: '1', @@ -233,6 +234,9 @@ describe('Test of helper / hook', () => { await hook.waitForNextUpdate(); }); - expect(hook.result.current.slice(0, 2)).toEqual([ElasticRequestState.Found, record]); + expect(hook.result.current.slice(0, 2)).toEqual([ + ElasticRequestState.Found, + buildDataTableRecord(record), + ]); }); }); diff --git a/src/plugins/discover/public/hooks/use_es_doc_search.ts b/src/plugins/discover/public/hooks/use_es_doc_search.ts index 84e759962de04..06c50af8e3889 100644 --- a/src/plugins/discover/public/hooks/use_es_doc_search.ts +++ b/src/plugins/discover/public/hooks/use_es_doc_search.ts @@ -10,10 +10,11 @@ import { useCallback, useEffect, useMemo, useState } from 'react'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { lastValueFrom } from 'rxjs'; import { DataView } from '@kbn/data-views-plugin/public'; +import { buildDataTableRecord } from '../utils/build_data_record'; +import { DataTableRecord } from '../types'; import { DocProps } from '../application/doc/components/doc'; import { ElasticRequestState } from '../application/doc/types'; import { SEARCH_FIELDS_FROM_SOURCE } from '../../common'; -import { ElasticSearchHit } from '../types'; import { useDiscoverServices } from './use_discover_services'; type RequestBody = Pick; @@ -26,9 +27,9 @@ export function useEsDocSearch({ index, indexPattern, requestSource, -}: DocProps): [ElasticRequestState, ElasticSearchHit | null, () => void] { +}: DocProps): [ElasticRequestState, DataTableRecord | null, () => void] { const [status, setStatus] = useState(ElasticRequestState.Loading); - const [hit, setHit] = useState(null); + const [hit, setHit] = useState(null); const { data, uiSettings } = useDiscoverServices(); const useNewFieldsApi = useMemo(() => !uiSettings.get(SEARCH_FIELDS_FROM_SOURCE), [uiSettings]); @@ -48,7 +49,7 @@ export function useEsDocSearch({ if (hits?.hits?.[0]) { setStatus(ElasticRequestState.Found); - setHit(hits.hits[0]); + setHit(buildDataTableRecord(hits.hits[0], indexPattern)); } else { setStatus(ElasticRequestState.NotFound); } diff --git a/src/plugins/discover/public/plugin.tsx b/src/plugins/discover/public/plugin.tsx index 24da9869238b0..e9eaba11d048c 100644 --- a/src/plugins/discover/public/plugin.tsx +++ b/src/plugins/discover/public/plugin.tsx @@ -241,8 +241,8 @@ export class DiscoverPlugin } > diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer.test.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer.test.tsx index 6d0018f695a33..41d483cb667c8 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer.test.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer.test.tsx @@ -12,6 +12,7 @@ import { DocViewer } from './doc_viewer'; import { findTestSubject } from '@elastic/eui/lib/test'; import { getDocViewsRegistry } from '../../../../kibana_services'; import { DocViewRenderProps } from '../../doc_views_types'; +import { buildDataTableRecord } from '../../../../utils/build_data_record'; jest.mock('../../../../kibana_services', () => { // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -75,7 +76,9 @@ test('Render with 1 tab displaying error message', () => { component: SomeComponent, }); - const renderProps = { hit: {} } as DocViewRenderProps; + const renderProps = { + hit: buildDataTableRecord({ _index: 't', _id: '1' }), + } as DocViewRenderProps; const errorMsg = 'Catch me if you can!'; const wrapper = mount(); diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.test.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.test.tsx index 1d5b1d4577652..af0bda4b67713 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.test.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.test.tsx @@ -10,17 +10,18 @@ import React from 'react'; import { shallow } from 'enzyme'; import { DocViewerTab } from './doc_viewer_tab'; import { indexPatternMock } from '../../../../__mocks__/index_pattern'; -import { ElasticSearchHit } from '../../../../types'; +import { buildDataTableRecord } from '../../../../utils/build_data_record'; describe('DocViewerTab', () => { test('changing columns triggers an update', () => { + const hit = buildDataTableRecord({ _index: 'test', _id: '1' }, indexPatternMock); const props = { title: 'test', component: jest.fn(), id: 1, render: jest.fn(), renderProps: { - hit: {} as ElasticSearchHit, + hit, columns: ['test'], indexPattern: indexPatternMock, }, @@ -31,7 +32,7 @@ describe('DocViewerTab', () => { const nextProps = { ...props, renderProps: { - hit: {} as ElasticSearchHit, + hit, columns: ['test2'], indexPattern: indexPatternMock, }, diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.tsx index 0ad3187e1cf4f..837ee910176b9 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer/doc_viewer_tab.tsx @@ -42,9 +42,8 @@ export class DocViewerTab extends React.Component { shouldComponentUpdate(nextProps: Props, nextState: State) { return ( - nextProps.renderProps.hit._id !== this.props.renderProps.hit._id || - nextProps.renderProps.hit._index !== this.props.renderProps.hit._index || - !isEqual(nextProps.renderProps.hit.highlight, this.props.renderProps.hit.highlight) || + nextProps.renderProps.hit.id !== this.props.renderProps.hit.id || + !isEqual(nextProps.renderProps.hit.raw.highlight, this.props.renderProps.hit.raw.highlight) || nextProps.id !== this.props.id || !isEqual(nextProps.renderProps.columns, this.props.renderProps.columns) || nextState.hasError diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/__snapshots__/source.test.tsx.snap b/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/__snapshots__/source.test.tsx.snap deleted file mode 100644 index 9b3cd1d056e03..0000000000000 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/__snapshots__/source.test.tsx.snap +++ /dev/null @@ -1,667 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`Source Viewer component renders error state 1`] = ` -
-
-
- -
-
-
-

- An Error Occurred -

- -
-
-
- Could not fetch data at this time. Refresh the tab to try again. -
- -
-
- -
-
-
-
-`; - -exports[`Source Viewer component renders json code editor 1`] = ` - - - - -
- -
- -
- - - - - - - - - - , - , - , - , - , - , - , - , - ], - }, - } - } - isStringTag={true} - serialized={ - Object { - "map": "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL3NwYWNlci9zcGFjZXIuc3R5bGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQW9CUSIsImZpbGUiOiIuLi8uLi8uLi9zcmMvY29tcG9uZW50cy9zcGFjZXIvc3BhY2VyLnN0eWxlcy50cyIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgRWxhc3RpY3NlYXJjaCBCLlYuIGFuZC9vciBsaWNlbnNlZCB0byBFbGFzdGljc2VhcmNoIEIuVi4gdW5kZXIgb25lXG4gKiBvciBtb3JlIGNvbnRyaWJ1dG9yIGxpY2Vuc2UgYWdyZWVtZW50cy4gTGljZW5zZWQgdW5kZXIgdGhlIEVsYXN0aWMgTGljZW5zZVxuICogMi4wIGFuZCB0aGUgU2VydmVyIFNpZGUgUHVibGljIExpY2Vuc2UsIHYgMTsgeW91IG1heSBub3QgdXNlIHRoaXMgZmlsZSBleGNlcHRcbiAqIGluIGNvbXBsaWFuY2Ugd2l0aCwgYXQgeW91ciBlbGVjdGlvbiwgdGhlIEVsYXN0aWMgTGljZW5zZSAyLjAgb3IgdGhlIFNlcnZlclxuICogU2lkZSBQdWJsaWMgTGljZW5zZSwgdiAxLlxuICovXG5cbmltcG9ydCB7IGNzcyB9IGZyb20gJ0BlbW90aW9uL3JlYWN0JztcbmltcG9ydCB7IGxvZ2ljYWxzIH0gZnJvbSAnLi4vLi4vZ2xvYmFsX3N0eWxpbmcnO1xuaW1wb3J0IHsgVXNlRXVpVGhlbWUgfSBmcm9tICcuLi8uLi9zZXJ2aWNlcyc7XG5cbmV4cG9ydCBjb25zdCBldWlTcGFjZXJTdHlsZXMgPSAoeyBldWlUaGVtZSB9OiBVc2VFdWlUaGVtZSkgPT4gKHtcbiAgZXVpU3BhY2VyOiBjc3NgXG4gICAgZmxleC1zaHJpbms6IDA7IC8vIGRvbid0IGV2ZXIgbGV0IHRoaXMgc2hyaW5rIGluIGhlaWdodCBpZiBkaXJlY3QgZGVzY2VuZGVudCBvZiBmbGV4O1xuICBgLFxuICAvLyBTaXplc1xuICB4czogY3NzYFxuICAgICR7bG9naWNhbHMuaGVpZ2h0fTogJHtldWlUaGVtZS5zaXplLnhzfTtcbiAgYCxcbiAgczogY3NzYFxuICAgICR7bG9naWNhbHMuaGVpZ2h0fTogJHtldWlUaGVtZS5zaXplLnN9O1xuICBgLFxuICBtOiBjc3NgXG4gICAgJHtsb2dpY2Fscy5oZWlnaHR9OiAke2V1aVRoZW1lLnNpemUuYmFzZX07XG4gIGAsXG4gIGw6IGNzc2BcbiAgICAke2xvZ2ljYWxzLmhlaWdodH06ICR7ZXVpVGhlbWUuc2l6ZS5sfTtcbiAgYCxcbiAgeGw6IGNzc2BcbiAgICAke2xvZ2ljYWxzLmhlaWdodH06ICR7ZXVpVGhlbWUuc2l6ZS54bH07XG4gIGAsXG4gIHh4bDogY3NzYFxuICAgICR7bG9naWNhbHMuaGVpZ2h0fTogJHtldWlUaGVtZS5zaXplLnh4bH07XG4gIGAsXG59KTtcbiJdfQ== */", - "name": "78drzl-euiSpacer-s", - "next": undefined, - "styles": "flex-shrink:0;label:euiSpacer;;;block-size:8px;;label:s;;;", - "toString": [Function], - } - } - /> -
-
- -
- - - - - - - - - -
-
- - -
- - - } - > - -
- -
- - - - -
- -
- - - - -`; - -exports[`Source Viewer component renders loading state 1`] = ` - -
- - - - - - - - , - , - , - , - ], - }, - } - } - isStringTag={true} - serialized={ - Object { - "map": "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xvYWRpbmcvbG9hZGluZ19zcGlubmVyLnN0eWxlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUE0RFUiLCJmaWxlIjoiLi4vLi4vLi4vc3JjL2NvbXBvbmVudHMvbG9hZGluZy9sb2FkaW5nX3NwaW5uZXIuc3R5bGVzLnRzIiwic291cmNlc0NvbnRlbnQiOlsiLypcbiAqIENvcHlyaWdodCBFbGFzdGljc2VhcmNoIEIuVi4gYW5kL29yIGxpY2Vuc2VkIHRvIEVsYXN0aWNzZWFyY2ggQi5WLiB1bmRlciBvbmVcbiAqIG9yIG1vcmUgY29udHJpYnV0b3IgbGljZW5zZSBhZ3JlZW1lbnRzLiBMaWNlbnNlZCB1bmRlciB0aGUgRWxhc3RpYyBMaWNlbnNlXG4gKiAyLjAgYW5kIHRoZSBTZXJ2ZXIgU2lkZSBQdWJsaWMgTGljZW5zZSwgdiAxOyB5b3UgbWF5IG5vdCB1c2UgdGhpcyBmaWxlIGV4Y2VwdFxuICogaW4gY29tcGxpYW5jZSB3aXRoLCBhdCB5b3VyIGVsZWN0aW9uLCB0aGUgRWxhc3RpYyBMaWNlbnNlIDIuMCBvciB0aGUgU2VydmVyXG4gKiBTaWRlIFB1YmxpYyBMaWNlbnNlLCB2IDEuXG4gKi9cblxuaW1wb3J0IHsgY3NzLCBrZXlmcmFtZXMgfSBmcm9tICdAZW1vdGlvbi9yZWFjdCc7XG5pbXBvcnQgeyBfRXVpVGhlbWVTaXplLCBldWlDYW5BbmltYXRlIH0gZnJvbSAnLi4vLi4vZ2xvYmFsX3N0eWxpbmcnO1xuaW1wb3J0IHsgVXNlRXVpVGhlbWUgfSBmcm9tICcuLi8uLi9zZXJ2aWNlcyc7XG5pbXBvcnQgeyBFdWlMb2FkaW5nU3Bpbm5lclNpemUgfSBmcm9tICcuL2xvYWRpbmdfc3Bpbm5lcic7XG5cbmNvbnN0IF9sb2FkaW5nU3Bpbm5lciA9IGtleWZyYW1lc2BcbiAgZnJvbSB7XG4gICAgdHJhbnNmb3JtOiByb3RhdGUoMGRlZyk7XG4gIH1cblxuICB0byB7XG4gICAgdHJhbnNmb3JtOiByb3RhdGUoMzU5ZGVnKTtcbiAgfVxuYDtcblxuY29uc3Qgc3Bpbm5lclNpemVzOiB7XG4gIFtzaXplIGluIEV1aUxvYWRpbmdTcGlubmVyU2l6ZV06IF9FdWlUaGVtZVNpemU7XG59ID0ge1xuICBzOiAnbScsXG4gIG06ICdiYXNlJyxcbiAgbDogJ2wnLFxuICB4bDogJ3hsJyxcbiAgeHhsOiAneHhsJyxcbn07XG5cbmNvbnN0IHNwaW5uZXJDb2xvcnMgPSAobWFpbjogc3RyaW5nLCBoaWdobGlnaHQ6IHN0cmluZykgPT4ge1xuICByZXR1cm4gYCR7aGlnaGxpZ2h0fSAke21haW59ICR7bWFpbn0gJHttYWlufWA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTG9hZGluZ1NwaW5uZXJTdHlsZXMgPSAoeyBldWlUaGVtZSB9OiBVc2VFdWlUaGVtZSkgPT4ge1xuICByZXR1cm4ge1xuICAgIGV1aUxvYWRpbmdTcGlubmVyOiBjc3NgXG4gICAgICBmbGV4LXNocmluazogMDsgLy8gRW5zdXJlcyBpdCBuZXZlciBzY2FsZXMgZG93biBiZWxvdyBpdHMgaW50ZW5kZWQgc2l6ZVxuICAgICAgZGlzcGxheTogaW5saW5lLWJsb2NrO1xuICAgICAgYm9yZGVyLXJhZGl1czogNTAlO1xuICAgICAgYm9yZGVyOiAke2V1aVRoZW1lLmJvcmRlci50aGlja307XG4gICAgICBib3JkZXItY29sb3I6ICR7c3Bpbm5lckNvbG9ycyhcbiAgICAgICAgZXVpVGhlbWUuYm9yZGVyLmNvbG9yLFxuICAgICAgICBldWlUaGVtZS5jb2xvcnMucHJpbWFyeVxuICAgICAgKX07XG5cbiAgICAgICR7ZXVpQ2FuQW5pbWF0ZX0ge1xuICAgICAgICBhbmltYXRpb246ICR7X2xvYWRpbmdTcGlubmVyfSAwLjZzIGluZmluaXRlIGxpbmVhcjtcbiAgICAgIH1cbiAgICBgLFxuXG4gICAgLy8gU2l6ZXNcbiAgICBzOiBjc3NgXG4gICAgICB3aWR0aDogJHtldWlUaGVtZS5zaXplW3NwaW5uZXJTaXplcy5zXX07XG4gICAgICBoZWlnaHQ6ICR7ZXVpVGhlbWUuc2l6ZVtzcGlubmVyU2l6ZXMuc119O1xuICAgICAgYm9yZGVyLXdpZHRoOiBjYWxjKCR7ZXVpVGhlbWUuYm9yZGVyLndpZHRoLnRoaW59ICogMS41KTtcbiAgICBgLFxuICAgIG06IGNzc2BcbiAgICAgIHdpZHRoOiAke2V1aVRoZW1lLnNpemVbc3Bpbm5lclNpemVzLm1dfTtcbiAgICAgIGhlaWdodDogJHtldWlUaGVtZS5zaXplW3NwaW5uZXJTaXplcy5tXX07XG4gICAgICBib3JkZXItd2lkdGg6IGNhbGMoJHtldWlUaGVtZS5ib3JkZXIud2lkdGgudGhpbn0gKiAxLjUpO1xuICAgIGAsXG4gICAgbDogY3NzYFxuICAgICAgd2lkdGg6ICR7ZXVpVGhlbWUuc2l6ZVtzcGlubmVyU2l6ZXMubF19O1xuICAgICAgaGVpZ2h0OiAke2V1aVRoZW1lLnNpemVbc3Bpbm5lclNpemVzLmxdfTtcbiAgICBgLFxuICAgIHhsOiBjc3NgXG4gICAgICB3aWR0aDogJHtldWlUaGVtZS5zaXplW3NwaW5uZXJTaXplcy54bF19O1xuICAgICAgaGVpZ2h0OiAke2V1aVRoZW1lLnNpemVbc3Bpbm5lclNpemVzLnhsXX07XG4gICAgYCxcbiAgICB4eGw6IGNzc2BcbiAgICAgIHdpZHRoOiAke2V1aVRoZW1lLnNpemVbc3Bpbm5lclNpemVzLnh4bF19O1xuICAgICAgaGVpZ2h0OiAke2V1aVRoZW1lLnNpemVbc3Bpbm5lclNpemVzLnh4bF19O1xuICAgIGAsXG4gIH07XG59O1xuIl19 */", - "name": "155ohbx-euiLoadingSpinner-m", - "next": Object { - "name": "animation-c24ia8", - "next": undefined, - "styles": "@keyframes animation-c24ia8{ - from { - transform: rotate(0deg); - } - - to { - transform: rotate(359deg); - } -}", - }, - "styles": "flex-shrink:0;display:inline-block;border-radius:50%;border:2px solid #D3DAE6;border-color:#07C #D3DAE6 #D3DAE6 #D3DAE6;@media screen and (prefers-reduced-motion: no-preference){animation:animation-c24ia8 0.6s infinite linear;};label:euiLoadingSpinner;;;width:16px;height:16px;border-width:calc(1px * 1.5);;label:m;;;", - "toString": [Function], - } - } - /> - - - - -
- -
- - Loading JSON - -
- -
- -
- -`; diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.test.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.test.tsx index 537cdf6d3dc4a..f51ddd13f1afe 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.test.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.test.tsx @@ -15,6 +15,7 @@ import * as useUiSettingHook from '@kbn/kibana-react-plugin/public/ui_settings/u import { EuiButton, EuiEmptyPrompt, EuiLoadingSpinner } from '@elastic/eui'; import { JsonCodeEditorCommon } from '../../../../components/json_code_editor/json_code_editor_common'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { buildDataTableRecord } from '../../../../utils/build_data_record'; const mockIndexPattern = { getComputedFields: () => [], @@ -51,7 +52,6 @@ describe('Source Viewer component', () => { /> ); - expect(comp.children()).toMatchSnapshot(); const loadingIndicator = comp.find(EuiLoadingSpinner); expect(loadingIndicator).not.toBe(null); }); @@ -70,7 +70,6 @@ describe('Source Viewer component', () => { /> ); - expect(comp.children().render()).toMatchSnapshot(); const errorPrompt = comp.find(EuiEmptyPrompt); expect(errorPrompt.length).toBe(1); const refreshButton = comp.find(EuiButton); @@ -78,9 +77,8 @@ describe('Source Viewer component', () => { }); test('renders json code editor', () => { - const mockHit = { + const mockHit = buildDataTableRecord({ _index: 'logstash-2014.09.09', - _type: 'doc', _id: 'id123', _score: 1, _source: { @@ -95,7 +93,7 @@ describe('Source Viewer component', () => { scripted: 123, _underscore: 123, }, - } as never; + }); jest.spyOn(hooks, 'useEsDocSearch').mockImplementation(() => [2, mockHit, () => {}]); jest.spyOn(useUiSettingHook, 'useUiSetting').mockImplementation(() => { return false; @@ -111,7 +109,6 @@ describe('Source Viewer component', () => { /> ); - expect(comp.children()).toMatchSnapshot(); const jsonCodeEditor = comp.find(JsonCodeEditorCommon); expect(jsonCodeEditor).not.toBe(null); }); diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.tsx index cbc14c9382e1c..ade467df853b0 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_source/source.tsx @@ -56,7 +56,7 @@ export const DocViewerSource = ({ useEffect(() => { if (reqState === ElasticRequestState.Found && hit) { - setJsonValue(JSON.stringify(hit, undefined, 2)); + setJsonValue(JSON.stringify(hit.raw, undefined, 2)); } }, [reqState, hit]); diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.test.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.test.tsx index 0e75ab7d7800d..053af6643eb79 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.test.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.test.tsx @@ -12,9 +12,9 @@ import { findTestSubject } from '@elastic/eui/lib/test'; import { DocViewerLegacyTable } from './table'; import { DataView } from '@kbn/data-views-plugin/public'; import { DocViewRenderProps } from '../../../doc_views_types'; -import { ElasticSearchHit } from '../../../../../types'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { DiscoverServices } from '../../../../../build_services'; +import { buildDataTableRecord } from '../../../../../utils/build_data_record'; const services = { uiSettings: { @@ -85,14 +85,14 @@ describe('DocViewTable at Discover', () => { // At Discover's main view, all buttons are rendered // check for existence of action buttons and warnings - const hit = { - _index: 'logstash-2014.09.09', - _type: 'doc', - _id: 'id123', - _score: 1, - _source: { - message: - 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \ + const hit = buildDataTableRecord( + { + _index: 'logstash-2014.09.09', + _id: 'id123', + _score: 1, + _source: { + message: + 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \ Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus \ et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, \ ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. \ @@ -100,17 +100,19 @@ describe('DocViewTable at Discover', () => { rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. \ Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. \ Phasellus ullamcorper ipsum rutrum nunc. Nunc nonummy metus. Vestibulum volutpat pretium libero. Cras id dui. Aenean ut', - extension: 'html', - not_mapped: 'yes', - bytes: 100, - objectArray: [{ foo: true }], - relatedContent: { - test: 1, + extension: 'html', + not_mapped: 'yes', + bytes: 100, + objectArray: [{ foo: true }], + relatedContent: { + test: 1, + }, + scripted: 123, + _underscore: 123, }, - scripted: 123, - _underscore: 123, }, - } as ElasticSearchHit; + indexPattern + ); const props = { hit, @@ -194,14 +196,14 @@ describe('DocViewTable at Discover', () => { describe('DocViewTable at Discover Context', () => { // here no toggleColumnButtons are rendered - const hit = { - _index: 'logstash-2014.09.09', - _type: 'doc', - _id: 'id123', - _score: 1, - _source: { - message: - 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \ + const hit = buildDataTableRecord( + { + _index: 'logstash-2014.09.09', + _id: 'id123', + _score: 1, + _source: { + message: + 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \ Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus \ et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, \ ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. \ @@ -209,8 +211,10 @@ describe('DocViewTable at Discover Context', () => { rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. \ Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. \ Phasellus ullamcorper ipsum rutrum nunc. Nunc nonummy metus. Vestibulum volutpat pretium libero. Cras id dui. Aenean ut', + }, }, - } as ElasticSearchHit; + indexPattern + ); const props = { hit, columns: ['extension'], @@ -246,16 +250,18 @@ describe('DocViewTable at Discover Context', () => { }); describe('DocViewTable at Discover Doc', () => { - const hit = { - _index: 'logstash-2014.09.09', - _score: 1, - _type: 'doc', - _id: 'id123', - _source: { - extension: 'html', - not_mapped: 'yes', + const hit = buildDataTableRecord( + { + _index: 'logstash-2014.09.09', + _score: 1, + _id: 'id123', + _source: { + extension: 'html', + not_mapped: 'yes', + }, }, - }; + indexPattern + ); // here no action buttons are rendered const props = { hit, @@ -370,20 +376,22 @@ describe('DocViewTable at Discover Doc with Fields API', () => { return indexPatterneCommerce.fields.getAll().find((field) => field.name === name); }; - const fieldsHit = { - _index: 'logstash-2014.09.09', - _type: 'doc', - _id: 'id123', - _score: 1.0, - fields: { - category: "Women's Clothing", - 'category.keyword': "Women's Clothing", - customer_first_name: 'Betty', - 'customer_first_name.keyword': 'Betty', - 'customer_first_name.nickname': 'Betsy', - 'city.raw': 'Los Angeles', + const fieldsHit = buildDataTableRecord( + { + _index: 'logstash-2014.09.09', + _id: 'id123', + _score: 1.0, + fields: { + category: "Women's Clothing", + 'category.keyword': "Women's Clothing", + customer_first_name: 'Betty', + 'customer_first_name.keyword': 'Betty', + 'customer_first_name.nickname': 'Betsy', + 'city.raw': 'Los Angeles', + }, }, - }; + indexPattern + ); const props = { hit: fieldsHit, columns: ['Document'], diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.tsx index 152a5451e7760..ad4345a79b166 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/legacy/table.tsx @@ -9,7 +9,6 @@ import '../table.scss'; import React, { useCallback, useMemo } from 'react'; import { EuiInMemoryTable } from '@elastic/eui'; -import { flattenHit } from '@kbn/data-plugin/public'; import { getTypeForFieldIcon } from '../../../../../utils/get_type_for_field_icon'; import { useDiscoverServices } from '../../../../../hooks/use_discover_services'; import { SHOW_MULTIFIELDS } from '../../../../../../common'; @@ -57,10 +56,9 @@ export const DocViewerLegacyTable = ({ }; }, []); - const flattened = flattenHit(hit, dataView, { source: true, includeIgnoredValues: true }); - const fieldsToShow = getFieldsToShow(Object.keys(flattened), dataView, showMultiFields); + const fieldsToShow = getFieldsToShow(Object.keys(hit.flattened), dataView, showMultiFields); - const items: FieldRecordLegacy[] = Object.keys(flattened) + const items: FieldRecordLegacy[] = Object.keys(hit.flattened) .filter((fieldName) => { return fieldsToShow.includes(fieldName); }) @@ -79,13 +77,13 @@ export const DocViewerLegacyTable = ({ : fieldMapping ? getTypeForFieldIcon(fieldMapping) : undefined; - const ignored = getIgnoredReason(fieldMapping ?? field, hit._ignored); + const ignored = getIgnoredReason(fieldMapping ?? field, hit.raw._ignored); return { action: { onToggleColumn, onFilter: filter, isActive: !!columns?.includes(field), - flattenedField: flattened[field], + flattenedField: hit.flattened[field], }, field: { field, @@ -96,8 +94,8 @@ export const DocViewerLegacyTable = ({ }, value: { formattedValue: formatFieldValue( - flattened[field], - hit, + hit.flattened[field], + hit.raw, fieldFormats, dataView, fieldMapping diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table.tsx index 48a869c86d3e8..7e61918aa7ae8 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table.tsx @@ -28,7 +28,6 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { debounce } from 'lodash'; import { Storage } from '@kbn/kibana-utils-plugin/public'; -import { flattenHit } from '@kbn/data-plugin/public'; import { getTypeForFieldIcon } from '../../../../utils/get_type_for_field_icon'; import { useDiscoverServices } from '../../../../hooks/use_discover_services'; import { usePager } from '../../../../hooks/use_pager'; @@ -119,7 +118,7 @@ export const DocViewerTable = ({ getPinnedFields(currentDataViewId, storage) ); - const flattened = flattenHit(hit, dataView, { source: true, includeIgnoredValues: true }); + const flattened = hit.flattened; const fieldsToShow = getFieldsToShow(Object.keys(flattened), dataView, showMultiFields); const searchPlaceholder = i18n.translate('discover.docView.table.searchPlaceHolder', { @@ -164,7 +163,7 @@ export const DocViewerTable = ({ ? getTypeForFieldIcon(fieldMapping) : undefined; - const ignored = getIgnoredReason(fieldMapping ?? field, hit._ignored); + const ignored = getIgnoredReason(fieldMapping ?? field, hit.raw._ignored); return { action: { @@ -184,8 +183,8 @@ export const DocViewerTable = ({ }, value: { formattedValue: formatFieldValue( - flattened[field], - hit, + hit.flattened[field], + hit.raw, fieldFormats, dataView, fieldMapping diff --git a/src/plugins/discover/public/services/doc_views/doc_views_registry.ts b/src/plugins/discover/public/services/doc_views/doc_views_registry.ts index 8ee8741d73d3f..d6bf89c5fef70 100644 --- a/src/plugins/discover/public/services/doc_views/doc_views_registry.ts +++ b/src/plugins/discover/public/services/doc_views/doc_views_registry.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { ElasticSearchHit } from '../../types'; import { DocView, DocViewInput, DocViewInputFn } from './doc_views_types'; +import { DataTableRecord } from '../../types'; export class DocViewsRegistry { private docViews: DocView[] = []; @@ -25,7 +25,7 @@ export class DocViewsRegistry { /** * Returns a sorted array of doc_views for rendering tabs */ - getDocViewsSorted(hit: ElasticSearchHit) { + getDocViewsSorted(hit: DataTableRecord) { return this.docViews .filter((docView) => docView.shouldShow(hit)) .sort((a, b) => (Number(a.order) > Number(b.order) ? 1 : -1)); diff --git a/src/plugins/discover/public/services/doc_views/doc_views_types.ts b/src/plugins/discover/public/services/doc_views/doc_views_types.ts index 171b29a86bb05..ca05bce452f91 100644 --- a/src/plugins/discover/public/services/doc_views/doc_views_types.ts +++ b/src/plugins/discover/public/services/doc_views/doc_views_types.ts @@ -7,7 +7,7 @@ */ import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; -import { ElasticSearchHit } from '../../types'; +import { DataTableRecord } from '../../types'; import { IgnoredReason } from '../../utils/get_ignored_reason'; export interface FieldMapping { @@ -26,7 +26,7 @@ export type DocViewFilterFn = ( ) => void; export interface DocViewRenderProps { - hit: ElasticSearchHit; + hit: DataTableRecord; indexPattern: DataView; columns?: string[]; filter?: DocViewFilterFn; @@ -41,7 +41,7 @@ export type DocViewRenderFn = ( export interface BaseDocViewInput { order: number; - shouldShow?: (hit: ElasticSearchHit) => boolean; + shouldShow?: (hit: DataTableRecord) => boolean; title: string; } diff --git a/src/plugins/discover/public/types.ts b/src/plugins/discover/public/types.ts index fa8582337349d..f96edccb5f9bf 100644 --- a/src/plugins/discover/public/types.ts +++ b/src/plugins/discover/public/types.ts @@ -6,14 +6,35 @@ * Side Public License, v 1. */ -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; - -export type ElasticSearchHit = estypes.SearchHit; - -export type HitsFlattened = Array>; +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; export type ValueToStringConverter = ( rowIndex: number, columnId: string, options?: { disableMultiline?: boolean } ) => { formattedString: string; withFormula: boolean }; + +export interface EsHitRecord extends Omit { + _source?: Record; +} +/** + * This is the record/row of data provided to our Data Table + */ +export interface DataTableRecord { + /** + * A unique id generated by index, id and routing of a record + */ + id: string; + /** + * The document returned by Elasticsearch for search queries + */ + raw: EsHitRecord; + /** + * A flattened version of the ES doc or data provided by SQL, aggregations ... + */ + flattened: Record; + /** + * Determines that the given doc is the anchor doc when rendering view surrounding docs + */ + isAnchor?: boolean; +} diff --git a/src/plugins/discover/public/utils/build_data_record.ts b/src/plugins/discover/public/utils/build_data_record.ts new file mode 100644 index 0000000000000..2691fddfb66a9 --- /dev/null +++ b/src/plugins/discover/public/utils/build_data_record.ts @@ -0,0 +1,43 @@ +/* + * 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. + */ + +import { DataView } from '@kbn/data-views-plugin/common'; +import { flattenHit } from '@kbn/data-plugin/common'; +import { getDocId } from './get_doc_id'; +import type { DataTableRecord, EsHitRecord } from '../types'; + +/** + * Build a record for data table, explorer + classic one + * @param doc the document returned from Elasticsearch + * @param dataView this current data view + * @param isAnchor determines if the given doc is the anchor doc when viewing surrounding documents + */ +export function buildDataTableRecord( + doc: EsHitRecord, + dataView?: DataView, + isAnchor?: boolean +): DataTableRecord { + return { + id: getDocId(doc), + raw: doc, + flattened: flattenHit(doc, dataView, { includeIgnoredValues: true }), + isAnchor, + }; +} + +/** + * Helper to build multiple DataTableRecords at once, saved a bit of testing code lines + * @param docs Array of documents returned from Elasticsearch + * @param dataView this current data view + */ +export function buildDataTableRecordList( + docs: EsHitRecord[], + dataView?: DataView +): DataTableRecord[] { + return docs.map((doc) => buildDataTableRecord(doc, dataView)); +} diff --git a/src/plugins/discover/public/utils/convert_value_to_string.test.tsx b/src/plugins/discover/public/utils/convert_value_to_string.test.tsx index e77d664851a23..64042c190feba 100644 --- a/src/plugins/discover/public/utils/convert_value_to_string.test.tsx +++ b/src/plugins/discover/public/utils/convert_value_to_string.test.tsx @@ -14,7 +14,6 @@ describe('convertValueToString', () => { it('should convert a keyword value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'keyword_key', @@ -30,7 +29,6 @@ describe('convertValueToString', () => { it('should convert a text value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'text_message', @@ -46,7 +44,6 @@ describe('convertValueToString', () => { it('should convert a multiline text value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'text_message', @@ -63,7 +60,6 @@ describe('convertValueToString', () => { it('should convert a number value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'number_price', @@ -79,7 +75,6 @@ describe('convertValueToString', () => { it('should convert a date value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'date', @@ -95,7 +90,6 @@ describe('convertValueToString', () => { it('should convert a date nanos value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'date_nanos', @@ -111,7 +105,6 @@ describe('convertValueToString', () => { it('should convert a boolean value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'bool_enabled', @@ -127,7 +120,6 @@ describe('convertValueToString', () => { it('should convert a binary value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'binary_blob', @@ -143,7 +135,6 @@ describe('convertValueToString', () => { it('should convert an object value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'object_user.first', @@ -159,7 +150,6 @@ describe('convertValueToString', () => { it('should convert a nested value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'nested_user', @@ -177,7 +167,6 @@ describe('convertValueToString', () => { it('should convert a flattened value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'flattened_labels', @@ -193,7 +182,6 @@ describe('convertValueToString', () => { it('should convert a range value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'range_time_frame', @@ -211,7 +199,6 @@ describe('convertValueToString', () => { it('should convert a rank features value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'rank_features', @@ -227,7 +214,6 @@ describe('convertValueToString', () => { it('should convert a histogram value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'histogram', @@ -243,7 +229,6 @@ describe('convertValueToString', () => { it('should convert a IP value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'ip_addr', @@ -259,7 +244,6 @@ describe('convertValueToString', () => { it('should convert a version value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'version', @@ -275,7 +259,6 @@ describe('convertValueToString', () => { it('should convert a vector value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'vector', @@ -291,7 +274,6 @@ describe('convertValueToString', () => { it('should convert a geo point value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'geo_point', @@ -307,7 +289,6 @@ describe('convertValueToString', () => { it('should convert a geo point object value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'geo_point', @@ -323,7 +304,6 @@ describe('convertValueToString', () => { it('should convert an array value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'array_tags', @@ -339,7 +319,6 @@ describe('convertValueToString', () => { it('should convert a shape value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'geometry', @@ -357,7 +336,6 @@ describe('convertValueToString', () => { it('should convert a runtime value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'runtime_number', @@ -373,7 +351,6 @@ describe('convertValueToString', () => { it('should convert a scripted value to text', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'scripted_string', @@ -389,7 +366,6 @@ describe('convertValueToString', () => { it('should return an empty string and not fail', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'unknown', @@ -405,7 +381,6 @@ describe('convertValueToString', () => { it('should return an empty string when rowIndex is out of range', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'unknown', @@ -421,7 +396,6 @@ describe('convertValueToString', () => { it('should return _source value', () => { const result = convertValueToString({ rows: discoverGridContextMock.rows, - rowsFlattened: discoverGridContextMock.rowsFlattened, dataView: discoverGridContextMock.indexPattern, services: discoverServiceMock, columnId: '_source', @@ -445,7 +419,6 @@ describe('convertValueToString', () => { it('should return a formatted _source value', () => { const result = convertValueToString({ rows: discoverGridContextMock.rows, - rowsFlattened: discoverGridContextMock.rowsFlattened, dataView: discoverGridContextMock.indexPattern, services: discoverServiceMock, columnId: '_source', @@ -463,7 +436,6 @@ describe('convertValueToString', () => { it('should escape formula', () => { const result = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'array_tags', @@ -478,7 +450,6 @@ describe('convertValueToString', () => { const result2 = convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, columnId: 'scripted_string', diff --git a/src/plugins/discover/public/utils/convert_value_to_string.ts b/src/plugins/discover/public/utils/convert_value_to_string.ts index 0f00725a69fb2..7c00bc0988cce 100644 --- a/src/plugins/discover/public/utils/convert_value_to_string.ts +++ b/src/plugins/discover/public/utils/convert_value_to_string.ts @@ -9,8 +9,8 @@ import { DataView } from '@kbn/data-views-plugin/public'; import { cellHasFormulas, createEscapeValue } from '@kbn/data-plugin/common'; import { formatFieldValue } from './format_value'; -import { ElasticSearchHit, HitsFlattened } from '../types'; import { DiscoverServices } from '../build_services'; +import { DataTableRecord } from '../types'; interface ConvertedResult { formattedString: string; @@ -20,15 +20,13 @@ interface ConvertedResult { export const convertValueToString = ({ rowIndex, rows, - rowsFlattened, columnId, dataView, services, options, }: { rowIndex: number; - rows: ElasticSearchHit[]; - rowsFlattened: HitsFlattened; + rows: DataTableRecord[]; columnId: string; dataView: DataView; services: DiscoverServices; @@ -37,7 +35,13 @@ export const convertValueToString = ({ }; }): ConvertedResult => { const { fieldFormats } = services; - const rowFlattened = rowsFlattened[rowIndex]; + if (!rows[rowIndex]) { + return { + formattedString: '', + withFormula: false, + }; + } + const rowFlattened = rows[rowIndex].flattened; const value = rowFlattened?.[columnId]; const field = dataView.fields.getByName(columnId); const valuesArray = Array.isArray(value) ? value : [value]; @@ -56,7 +60,7 @@ export const convertValueToString = ({ .map((subValue) => { const formattedValue = formatFieldValue( subValue, - rows[rowIndex], + rows[rowIndex].raw, fieldFormats, dataView, field, diff --git a/src/plugins/discover/public/utils/copy_value_to_clipboard.test.tsx b/src/plugins/discover/public/utils/copy_value_to_clipboard.test.tsx index 3f3beed866eca..842d8147aece1 100644 --- a/src/plugins/discover/public/utils/copy_value_to_clipboard.test.tsx +++ b/src/plugins/discover/public/utils/copy_value_to_clipboard.test.tsx @@ -23,7 +23,6 @@ describe('copyValueToClipboard', () => { const valueToStringConverter: ValueToStringConverter = (rowIndex, columnId, options) => convertValueToString({ rows: discoverGridContextComplexMock.rows, - rowsFlattened: discoverGridContextComplexMock.rowsFlattened, dataView: discoverGridContextComplexMock.indexPattern, services: discoverServiceMock, rowIndex, diff --git a/src/plugins/discover/public/utils/format_hit.test.ts b/src/plugins/discover/public/utils/format_hit.test.ts index 601d88cdedc96..c273a565ff645 100644 --- a/src/plugins/discover/public/utils/format_hit.test.ts +++ b/src/plugins/discover/public/utils/format_hit.test.ts @@ -6,13 +6,15 @@ * Side Public License, v 1. */ -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { indexPatternMock as dataViewMock } from '../__mocks__/index_pattern'; import { formatHit } from './format_hit'; import { discoverServiceMock } from '../__mocks__/services'; +import { DataTableRecord, EsHitRecord } from '../types'; +import { buildDataTableRecord } from './build_data_record'; describe('formatHit', () => { - let hit: estypes.SearchHit; + let row: DataTableRecord; + let hit: EsHitRecord; beforeEach(() => { hit = { _id: '1', @@ -24,6 +26,7 @@ describe('formatHit', () => { bytes: [123], }, }; + row = buildDataTableRecord(hit, dataViewMock); (dataViewMock.getFormatterForField as jest.Mock).mockReturnValue({ convert: (value: unknown) => `formatted:${value}`, }); @@ -35,7 +38,7 @@ describe('formatHit', () => { it('formats a document as expected', () => { const formatted = formatHit( - hit, + row, dataViewMock, ['message', 'extension', 'object.value'], 220, @@ -51,8 +54,16 @@ describe('formatHit', () => { }); it('orders highlighted fields first', () => { + const highlightHit = buildDataTableRecord( + { + ...hit, + highlight: { message: ['%%'] }, + }, + dataViewMock + ); + const formatted = formatHit( - { ...hit, highlight: { message: ['%%'] } }, + highlightHit, dataViewMock, ['message', 'extension', 'object.value'], 220, @@ -69,7 +80,7 @@ describe('formatHit', () => { it('only limits count of pairs based on advanced setting', () => { const formatted = formatHit( - hit, + row, dataViewMock, ['message', 'extension', 'object.value'], 2, @@ -84,7 +95,7 @@ describe('formatHit', () => { it('should not include fields not mentioned in fieldsToShow', () => { const formatted = formatHit( - hit, + row, dataViewMock, ['message', 'object.value'], 220, @@ -100,7 +111,7 @@ describe('formatHit', () => { it('should filter fields based on their real name not displayName', () => { const formatted = formatHit( - hit, + row, dataViewMock, ['bytes'], 220, diff --git a/src/plugins/discover/public/utils/format_hit.ts b/src/plugins/discover/public/utils/format_hit.ts index 6af6a8aa61210..4e3c6160109c6 100644 --- a/src/plugins/discover/public/utils/format_hit.ts +++ b/src/plugins/discover/public/utils/format_hit.ts @@ -9,8 +9,8 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { i18n } from '@kbn/i18n'; import { FieldFormatsStart } from '@kbn/field-formats-plugin/public'; -import { flattenHit } from '@kbn/data-plugin/public'; import { DataView } from '@kbn/data-views-plugin/public'; +import { DataTableRecord } from '../types'; import { formatFieldValue } from './format_value'; const formattedHitCache = new WeakMap(); @@ -26,20 +26,20 @@ type FormattedHit = Array; * @param fieldsToShow A list of fields that should be included in the document summary. */ export function formatHit( - hit: estypes.SearchHit, + hit: DataTableRecord, dataView: DataView, fieldsToShow: string[], maxEntries: number, fieldFormats: FieldFormatsStart ): FormattedHit { - const cached = formattedHitCache.get(hit); + const cached = formattedHitCache.get(hit.raw); if (cached) { return cached; } - const highlights = hit.highlight ?? {}; + const highlights = hit.raw.highlight ?? {}; // Flatten the object using the flattenHit implementation we use across Discover for flattening documents. - const flattened = flattenHit(hit, dataView, { includeIgnoredValues: true, source: true }); + const flattened = hit.flattened; const highlightPairs: Array<[fieldName: string, formattedValue: string]> = []; const sourcePairs: Array<[fieldName: string, formattedValue: string]> = []; @@ -54,7 +54,7 @@ export function formatHit( // Format the raw value using the regular field formatters for that field const formattedValue = formatFieldValue( val, - hit, + hit.raw, fieldFormats, dataView, dataView.fields.getByName(key) @@ -85,6 +85,6 @@ export function formatHit( '', ] as const, ]; - formattedHitCache.set(hit, formatted); + formattedHitCache.set(hit.raw, formatted); return formatted; } diff --git a/src/plugins/discover/public/utils/get_doc_id.tsx b/src/plugins/discover/public/utils/get_doc_id.tsx new file mode 100644 index 0000000000000..5b6b638d3b562 --- /dev/null +++ b/src/plugins/discover/public/utils/get_doc_id.tsx @@ -0,0 +1,17 @@ +/* + * 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. + */ + +import { EsHitRecord } from '../types'; +/** + * Returning a generated id of a given ES document, since `_id` can be the same + * when using different indices and shard routing + */ +export const getDocId = (doc: EsHitRecord & { _routing?: string }) => { + const routing = doc._routing ? doc._routing : ''; + return [doc._index, doc._id, routing].join('::'); +}; diff --git a/src/plugins/embeddable/public/lib/embeddables/error_embeddable.test.tsx b/src/plugins/embeddable/public/lib/embeddables/error_embeddable.test.tsx index 6b8cd4cd55a5f..8d87b1d781f20 100644 --- a/src/plugins/embeddable/public/lib/embeddables/error_embeddable.test.tsx +++ b/src/plugins/embeddable/public/lib/embeddables/error_embeddable.test.tsx @@ -40,7 +40,7 @@ test('ErrorEmbeddable renders in compact mode', async () => { class="euiPopover__anchor errorEmbeddableCompact__popoverAnchor" >
+
+
+
-
- - - -
- - - - -
+

+ Exit full screen +

+
+
+
+
+ +
+ +
- +
`; diff --git a/src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.test.tsx b/src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.test.tsx index 6b45111df836e..8201133b0d2d6 100644 --- a/src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.test.tsx +++ b/src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.test.tsx @@ -26,7 +26,7 @@ describe('', () => { ); - expect(component).toMatchSnapshot(); + expect(component.render()).toMatchSnapshot(); }); test('passing `false` to toggleChrome does not toggle chrome', () => { diff --git a/src/plugins/kibana_react/public/page_template/__snapshots__/page_template.test.tsx.snap b/src/plugins/kibana_react/public/page_template/__snapshots__/page_template.test.tsx.snap index 4f2fd7cee4a5a..3f61ab83ff1fa 100644 --- a/src/plugins/kibana_react/public/page_template/__snapshots__/page_template.test.tsx.snap +++ b/src/plugins/kibana_react/public/page_template/__snapshots__/page_template.test.tsx.snap @@ -22,7 +22,7 @@ exports[`KibanaPageTemplate render basic template 1`] = ` class="euiFlexItem" >

test @@ -46,7 +46,7 @@ exports[`KibanaPageTemplate render basic template 1`] = `

test @@ -237,7 +237,7 @@ exports[`KibanaPageTemplate render solutionNav 1`] = `

@@ -45,7 +45,7 @@ exports[`NoDataCard props button 1`] = ` exports[`NoDataCard props href 1`] = `

@@ -95,7 +95,7 @@ exports[`NoDataCard props href 1`] = ` exports[`NoDataCard props recommended 1`] = `

@@ -131,7 +131,7 @@ exports[`NoDataCard props recommended 1`] = ` exports[`NoDataCard renders 1`] = `

diff --git a/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap b/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap index f0ca2221d207b..7cf46888594f7 100644 --- a/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap +++ b/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap @@ -2,7 +2,7 @@ exports[`NotFoundErrors component renders correctly for index-pattern type 1`] = `

-
-
- The data view associated with this object no longer exists. -
-
- If you know what this error means, you can use the - + The data view associated with this object no longer exists. +
+ + (opens in a new tab or window) + + + to fix it — otherwise click the delete button above.
@@ -55,7 +51,7 @@ exports[`NotFoundErrors component renders correctly for index-pattern type 1`] = exports[`NotFoundErrors component renders correctly for index-pattern-field type 1`] = `

-
-
- A field associated with this object no longer exists in the data view. -
-
- If you know what this error means, you can use the - + A field associated with this object no longer exists in the data view. +
+ + (opens in a new tab or window) + + + to fix it — otherwise click the delete button above.
@@ -108,7 +100,7 @@ exports[`NotFoundErrors component renders correctly for index-pattern-field type exports[`NotFoundErrors component renders correctly for search type 1`] = `

-
-
- The saved search associated with this object no longer exists. -
-
- If you know what this error means, you can use the - + The saved search associated with this object no longer exists. +
+ + (opens in a new tab or window) + + + to fix it — otherwise click the delete button above.
@@ -161,7 +149,7 @@ exports[`NotFoundErrors component renders correctly for search type 1`] = ` exports[`NotFoundErrors component renders correctly for unknown type 1`] = `

-
-
-
- If you know what this error means, you can use the - + + (opens in a new tab or window) + + + to fix it — otherwise click the delete button above.
diff --git a/src/plugins/saved_objects_management/public/management_section/objects_table/components/overwrite_modal.tsx b/src/plugins/saved_objects_management/public/management_section/objects_table/components/overwrite_modal.tsx index cfe0b2be1d3c0..4458ed02f4f4c 100644 --- a/src/plugins/saved_objects_management/public/management_section/objects_table/components/overwrite_modal.tsx +++ b/src/plugins/saved_objects_management/public/management_section/objects_table/components/overwrite_modal.tsx @@ -46,7 +46,7 @@ export const OverwriteModal = ({ conflict, onFinish }: OverwriteModalProps) => { {header} -

+

{idText}
{lastUpdatedText} diff --git a/src/plugins/unified_search/public/dataview_picker/dataview_list.test.tsx b/src/plugins/unified_search/public/dataview_picker/dataview_list.test.tsx index 813beae20369c..6bbbe6d8df05b 100644 --- a/src/plugins/unified_search/public/dataview_picker/dataview_list.test.tsx +++ b/src/plugins/unified_search/public/dataview_picker/dataview_list.test.tsx @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import React from 'react'; +import React, { MouseEvent } from 'react'; import { EuiSelectable } from '@elastic/eui'; import { act } from 'react-dom/test-utils'; import { ShallowWrapper } from 'enzyme'; @@ -22,6 +22,7 @@ function getDataViewPickerOptions(instance: ShallowWrapper) { } function selectDataViewPickerOption(instance: ShallowWrapper, selectedLabel: string) { + const event = {} as MouseEvent; const options: Array<{ label: string; checked?: 'on' | 'off' }> = getDataViewPickerOptions( instance ).map((option: { label: string }) => @@ -29,7 +30,7 @@ function selectDataViewPickerOption(instance: ShallowWrapper, selectedLabel: str ? { ...option, checked: 'on' } : { ...option, checked: undefined } ); - return getDataViewPickerList(instance).prop('onChange')!(options); + return getDataViewPickerList(instance).prop('onChange')!(options, event); } describe('DataView list component', () => { diff --git a/src/plugins/unified_search/public/filter_bar/filter_editor/lib/__snapshots__/filter_label.test.tsx.snap b/src/plugins/unified_search/public/filter_bar/filter_editor/lib/__snapshots__/filter_label.test.tsx.snap index 82ac1e09386c1..58e9fa6307687 100644 --- a/src/plugins/unified_search/public/filter_bar/filter_editor/lib/__snapshots__/filter_label.test.tsx.snap +++ b/src/plugins/unified_search/public/filter_bar/filter_editor/lib/__snapshots__/filter_label.test.tsx.snap @@ -10,7 +10,7 @@ exports[`alias 1`] = ` exports[`alias with error status 1`] = `

NOT @@ -27,7 +27,7 @@ exports[`alias with error status 1`] = ` exports[`alias with warning status 1`] = `
NOT diff --git a/src/plugins/usage_collection/tsconfig.json b/src/plugins/usage_collection/tsconfig.json index 7fac30a8048ea..0430eb5d64bf1 100644 --- a/src/plugins/usage_collection/tsconfig.json +++ b/src/plugins/usage_collection/tsconfig.json @@ -17,4 +17,4 @@ { "path": "../../core/tsconfig.json" }, { "path": "../../plugins/kibana_utils/tsconfig.json" } ] -} +} \ No newline at end of file diff --git a/src/plugins/vis_default_editor/public/components/__snapshots__/agg.test.tsx.snap b/src/plugins/vis_default_editor/public/components/__snapshots__/agg.test.tsx.snap index dd9a923269294..becf550348d50 100644 --- a/src/plugins/vis_default_editor/public/components/__snapshots__/agg.test.tsx.snap +++ b/src/plugins/vis_default_editor/public/components/__snapshots__/agg.test.tsx.snap @@ -1,9 +1,8 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`DefaultEditorAgg component should init with the default set of props 1`] = ` - @@ -12,10 +11,8 @@ exports[`DefaultEditorAgg component should init with the default set of props 1` } buttonContentClassName="visEditorSidebar__aggGroupAccordionButtonContent eui-textTruncate" - buttonElement="button" className="visEditorSidebar__section visEditorSidebar__collapsible visEditorSidebar__collapsible--marginBottom" data-test-subj="visEditorAggAccordion1" - element="div" extraAction={ - + `; diff --git a/src/plugins/vis_default_editor/public/components/agg.test.tsx b/src/plugins/vis_default_editor/public/components/agg.test.tsx index c6a4057c9b415..c8ffb3abc0463 100644 --- a/src/plugins/vis_default_editor/public/components/agg.test.tsx +++ b/src/plugins/vis_default_editor/public/components/agg.test.tsx @@ -129,7 +129,7 @@ describe('DefaultEditorAgg component', () => { const comp = mount(); expect(defaultProps.setAggsState).toBeCalledTimes(0); - comp.find('.euiAccordion__button').simulate('click'); + comp.find('.euiAccordion__button').last().simulate('click'); // make sure that the accordion is collapsed expect(comp.find('.euiAccordion-isOpen').exists()).toBeFalsy(); diff --git a/src/plugins/vis_types/timeseries/public/application/components/data_format_picker.tsx b/src/plugins/vis_types/timeseries/public/application/components/data_format_picker.tsx index fdfdd1427b51d..c057a741a0037 100644 --- a/src/plugins/vis_types/timeseries/public/application/components/data_format_picker.tsx +++ b/src/plugins/vis_types/timeseries/public/application/components/data_format_picker.tsx @@ -46,7 +46,7 @@ const getDataFormatPickerOptions = ( <> {defaultOptionLabel} -

+

{i18n.translate('visTypeTimeseries.dataFormatPicker.defaultLabelDescription', { defaultMessage: 'Applies common formatting', })} diff --git a/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axes_panel.test.tsx.snap b/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axes_panel.test.tsx.snap index 1dd916f827fe6..7017d6f278565 100644 --- a/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axes_panel.test.tsx.snap +++ b/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axes_panel.test.tsx.snap @@ -45,9 +45,8 @@ exports[`ValueAxesPanel component should init with the default set of props 1`] - @@ -66,10 +65,8 @@ exports[`ValueAxesPanel component should init with the default set of props 1`] } buttonContentClassName="visEditorSidebar__aggGroupAccordionButtonContent eui-textTruncate" - buttonElement="button" className="visEditorSidebar__section visEditorSidebar__collapsible" data-test-subj="toggleYAxisOptions-ValueAxis-1" - element="div" extraAction={ - - + @@ -178,10 +171,8 @@ exports[`ValueAxesPanel component should init with the default set of props 1`] } buttonContentClassName="visEditorSidebar__aggGroupAccordionButtonContent eui-textTruncate" - buttonElement="button" className="visEditorSidebar__section visEditorSidebar__collapsible" data-test-subj="toggleYAxisOptions-ValueAxis-2" - element="div" extraAction={ - + `; diff --git a/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axis_options.test.tsx.snap b/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axis_options.test.tsx.snap index b036cd93d300b..73025e7f49c0f 100644 --- a/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axis_options.test.tsx.snap +++ b/src/plugins/vis_types/xy/public/editor/components/options/metrics_axes/__snapshots__/value_axis_options.test.tsx.snap @@ -112,19 +112,13 @@ exports[`ValueAxisOptions component should init with the default set of props 1` - - + `; diff --git a/src/plugins/visualizations/public/components/__snapshots__/visualization_noresults.test.js.snap b/src/plugins/visualizations/public/components/__snapshots__/visualization_noresults.test.js.snap index 98d37568e4541..b01fd0095c438 100644 --- a/src/plugins/visualizations/public/components/__snapshots__/visualization_noresults.test.js.snap +++ b/src/plugins/visualizations/public/components/__snapshots__/visualization_noresults.test.js.snap @@ -6,7 +6,7 @@ exports[`VisualizationNoResults should render according to snapshot 1`] = ` data-test-subj="visNoResult" >

-
-
- No results found -
+ No results found
- +
diff --git a/src/plugins/visualizations/public/components/visualization_error.tsx b/src/plugins/visualizations/public/components/visualization_error.tsx index 8ec9f3c71f00c..8e49211b4b949 100644 --- a/src/plugins/visualizations/public/components/visualization_error.tsx +++ b/src/plugins/visualizations/public/components/visualization_error.tsx @@ -22,7 +22,7 @@ export class VisualizationError extends React.Component iconColor="danger" data-test-subj="visualization-error" body={ - + {typeof this.props.error === 'string' ? this.props.error : this.props.error.message} } diff --git a/src/plugins/visualizations/public/components/visualization_noresults.tsx b/src/plugins/visualizations/public/components/visualization_noresults.tsx index 5b03da62fbf42..e733b6b51bf17 100644 --- a/src/plugins/visualizations/public/components/visualization_noresults.tsx +++ b/src/plugins/visualizations/public/components/visualization_noresults.tsx @@ -23,7 +23,7 @@ export class VisualizationNoResults extends React.Component + {i18n.translate('visualizations.noResultsFoundTitle', { defaultMessage: 'No results found', })} diff --git a/src/plugins/visualizations/public/wizard/new_vis_modal.test.tsx b/src/plugins/visualizations/public/wizard/new_vis_modal.test.tsx index cdbaab8e73abf..36d756d63f660 100644 --- a/src/plugins/visualizations/public/wizard/new_vis_modal.test.tsx +++ b/src/plugins/visualizations/public/wizard/new_vis_modal.test.tsx @@ -151,7 +151,7 @@ describe('NewVisModal', () => { savedObjects={{} as SavedObjectsStart} /> ); - const visCard = wrapper.find('[data-test-subj="visType-vis"]').at(0); + const visCard = wrapper.find('[data-test-subj="visType-vis"]').last(); visCard.simulate('click'); expect(window.location.assign).toBeCalledWith('testbasepath/app/visualize#/create?type=vis'); }); @@ -170,7 +170,7 @@ describe('NewVisModal', () => { savedObjects={{} as SavedObjectsStart} /> ); - const visCard = wrapper.find('[data-test-subj="visType-vis"]').at(0); + const visCard = wrapper.find('[data-test-subj="visType-vis"]').last(); visCard.simulate('click'); expect(window.location.assign).toBeCalledWith( 'testbasepath/app/visualize#/create?type=vis&foo=true&bar=42' @@ -196,7 +196,7 @@ describe('NewVisModal', () => { savedObjects={{} as SavedObjectsStart} /> ); - const visCard = wrapper.find('[data-test-subj="visType-visWithAliasUrl"]').at(0); + const visCard = wrapper.find('[data-test-subj="visType-visWithAliasUrl"]').last(); visCard.simulate('click'); expect(stateTransfer.navigateToEditor).toBeCalledWith('otherApp', { path: '#/aliasUrl', @@ -221,7 +221,7 @@ describe('NewVisModal', () => { savedObjects={{} as SavedObjectsStart} /> ); - const visCard = wrapper.find('[data-test-subj="visType-visWithAliasUrl"]').at(0); + const visCard = wrapper.find('[data-test-subj="visType-visWithAliasUrl"]').last(); visCard.simulate('click'); expect(navigateToApp).toBeCalledWith('otherApp', { path: '#/aliasUrl' }); expect(onClose).toHaveBeenCalled(); diff --git a/test/accessibility/apps/management.ts b/test/accessibility/apps/management.ts index 0f65a3561c4a0..25db943a8fcf1 100644 --- a/test/accessibility/apps/management.ts +++ b/test/accessibility/apps/management.ts @@ -21,83 +21,83 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const testSubjects = getService('testSubjects'); describe('Management', () => { - before(async () => { - await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/logstash_functional'); - await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); - await kibanaServer.uiSettings.update({ - defaultIndex: 'logstash-*', - }); - await PageObjects.settings.navigateTo(); - }); - - after(async () => { - await kibanaServer.importExport.unload('test/functional/fixtures/kbn_archiver/discover'); - await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); - }); - it('main view', async () => { await a11y.testAppSnapshot(); }); - it('index pattern page', async () => { - await PageObjects.settings.clickKibanaIndexPatterns(); - await a11y.testAppSnapshot(); - }); + describe('data views', async () => { + before(async () => { + await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); + await kibanaServer.uiSettings.update({ + defaultIndex: 'logstash-*', + }); + await PageObjects.settings.navigateTo(); + }); + after(async () => { + await kibanaServer.importExport.unload('test/functional/fixtures/kbn_archiver/discover'); + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + }); + it('index pattern page', async () => { + await PageObjects.settings.clickKibanaIndexPatterns(); + await a11y.testAppSnapshot(); + }); - it('Single indexpattern view', async () => { - await PageObjects.settings.clickIndexPatternLogstash(); - await PageObjects.header.waitUntilLoadingHasFinished(); - await a11y.testAppSnapshot(); - }); + it('Single indexpattern view', async () => { + await PageObjects.settings.clickIndexPatternLogstash(); + await PageObjects.header.waitUntilLoadingHasFinished(); + await a11y.testAppSnapshot(); + }); - it('Index pattern field editor - initial view', async () => { - await PageObjects.settings.clickAddField(); - await a11y.testAppSnapshot(); - }); + it('Index pattern field editor - initial view', async () => { + await PageObjects.settings.clickAddField(); + await a11y.testAppSnapshot(); + }); - it('Index pattern field editor - all options shown', async () => { - await PageObjects.settings.setFieldName('test'); - await PageObjects.settings.setFieldType('Keyword'); - await PageObjects.settings.setFieldScript("emit('hello world')"); - await PageObjects.settings.toggleRow('formatRow'); - await PageObjects.settings.setFieldFormat('string'); - await PageObjects.settings.toggleRow('customLabelRow'); - await PageObjects.settings.setCustomLabel('custom label'); - await testSubjects.click('toggleAdvancedSetting'); - // Let's make sure the field preview is visible before testing the snapshot - const isFieldPreviewVisible = - await PageObjects.indexPatternFieldEditorObjects.isFieldPreviewVisible(); - expect(isFieldPreviewVisible).to.be(true); + it('Index pattern field editor - all options shown', async () => { + await PageObjects.settings.setFieldName('test'); + await PageObjects.settings.setFieldType('Keyword'); + await PageObjects.settings.setFieldScript("emit('hello world')"); + await PageObjects.settings.toggleRow('formatRow'); + await PageObjects.settings.setFieldFormat('string'); + await PageObjects.settings.toggleRow('customLabelRow'); + await PageObjects.settings.setCustomLabel('custom label'); + await testSubjects.click('toggleAdvancedSetting'); + // Let's make sure the field preview is visible before testing the snapshot + const isFieldPreviewVisible = + await PageObjects.indexPatternFieldEditorObjects.isFieldPreviewVisible(); + expect(isFieldPreviewVisible).to.be(true); - await a11y.testAppSnapshot(); + await a11y.testAppSnapshot(); - await PageObjects.settings.closeIndexPatternFieldEditor(); - }); + await PageObjects.settings.closeIndexPatternFieldEditor(); + }); - it('Open create index pattern wizard', async () => { - await PageObjects.settings.clickKibanaIndexPatterns(); - await PageObjects.settings.clickAddNewIndexPatternButton(); - await PageObjects.header.waitUntilLoadingHasFinished(); - await a11y.testAppSnapshot(); - await testSubjects.click('closeFlyoutButton'); - }); + it('Open create index pattern wizard', async () => { + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickAddNewIndexPatternButton(); + await PageObjects.header.waitUntilLoadingHasFinished(); + await a11y.testAppSnapshot(); + await testSubjects.click('closeFlyoutButton'); + }); - // We are navigating back to index pattern page to test field formatters - it('Navigate back to logstash index page', async () => { - await PageObjects.settings.clickKibanaIndexPatterns(); - await PageObjects.settings.clickIndexPatternLogstash(); - await a11y.testAppSnapshot(); - }); + // We are navigating back to index pattern page to test field formatters + it('Navigate back to logstash index page', async () => { + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + await a11y.testAppSnapshot(); + }); - it('Edit field type', async () => { - await PageObjects.settings.clickEditFieldFormat(); - await a11y.testAppSnapshot(); - await PageObjects.settings.closeIndexPatternFieldEditor(); - }); + it('Edit field type', async () => { + await PageObjects.settings.clickEditFieldFormat(); + await a11y.testAppSnapshot(); + await PageObjects.settings.closeIndexPatternFieldEditor(); + }); - it('Advanced settings', async () => { - await PageObjects.settings.clickKibanaSettings(); - await a11y.testAppSnapshot(); + it('Advanced settings', async () => { + await PageObjects.settings.clickKibanaSettings(); + await a11y.testAppSnapshot(); + }); }); }); } diff --git a/test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts b/test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts index 53493b99ad1ad..9b7310529eed3 100644 --- a/test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts +++ b/test/analytics/tests/instrumented_events/from_the_browser/loaded_kibana.ts @@ -25,7 +25,22 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(event.properties).to.have.property('kibana_version'); expect(event.properties.kibana_version).to.be.a('string'); + // Kibana Loaded timings + expect(event.properties).to.have.property('load_started'); + expect(event.properties.load_started).to.be.a('number'); + expect(event.properties).to.have.property('bootstrap_started'); + expect(event.properties.bootstrap_started).to.be.a('number'); + expect(event.properties).to.have.property('core_created'); + expect(event.properties.core_created).to.be.a('number'); + expect(event.properties).to.have.property('setup_done'); + expect(event.properties.setup_done).to.be.a('number'); + expect(event.properties).to.have.property('start_done'); + expect(event.properties.start_done).to.be.a('number'); + expect(event.properties).to.have.property('first_app_nav'); + expect(event.properties.start_done).to.be.a('number'); + if (browser.isChromium) { + // Kibana Loaded memory expect(event.properties).to.have.property('memory_js_heap_size_limit'); expect(event.properties.memory_js_heap_size_limit).to.be.a('number'); expect(event.properties).to.have.property('memory_js_heap_size_total'); diff --git a/test/functional/apps/context/_context_navigation.ts b/test/functional/apps/context/_context_navigation.ts index 15de70882086e..1bda70cc558ee 100644 --- a/test/functional/apps/context/_context_navigation.ts +++ b/test/functional/apps/context/_context_navigation.ts @@ -30,7 +30,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { before(async () => { await PageObjects.timePicker.setDefaultAbsoluteRangeViaUiSettings(); await kibanaServer.uiSettings.update({ - 'doc_table:legacy': false, defaultIndex: 'logstash-*', }); await PageObjects.common.navigateToApp('discover'); diff --git a/test/functional/apps/context/_date_nanos.ts b/test/functional/apps/context/_date_nanos.ts index 969a7dcecd5c3..b486dd77ecef8 100644 --- a/test/functional/apps/context/_date_nanos.ts +++ b/test/functional/apps/context/_date_nanos.ts @@ -30,7 +30,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await kibanaServer.uiSettings.update({ 'context:defaultSize': `${TEST_DEFAULT_CONTEXT_SIZE}`, 'context:step': `${TEST_STEP_SIZE}`, - 'doc_table:legacy': false, }); }); diff --git a/test/functional/apps/context/_date_nanos_custom_timestamp.ts b/test/functional/apps/context/_date_nanos_custom_timestamp.ts index b8af57e40a3e3..b91aafa89dabf 100644 --- a/test/functional/apps/context/_date_nanos_custom_timestamp.ts +++ b/test/functional/apps/context/_date_nanos_custom_timestamp.ts @@ -32,7 +32,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await kibanaServer.uiSettings.update({ 'context:defaultSize': `${TEST_DEFAULT_CONTEXT_SIZE}`, 'context:step': `${TEST_STEP_SIZE}`, - 'doc_table:legacy': false, }); }); diff --git a/test/functional/apps/context/_discover_navigation.ts b/test/functional/apps/context/_discover_navigation.ts index 5add260d8f4d0..46f03b512bff3 100644 --- a/test/functional/apps/context/_discover_navigation.ts +++ b/test/functional/apps/context/_discover_navigation.ts @@ -37,7 +37,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { before(async () => { await PageObjects.timePicker.setDefaultAbsoluteRangeViaUiSettings(); await kibanaServer.uiSettings.update({ - 'doc_table:legacy': false, defaultIndex: 'logstash-*', }); await PageObjects.common.navigateToApp('discover'); diff --git a/test/functional/apps/context/_filters.ts b/test/functional/apps/context/_filters.ts index fe5b27f2f8055..e8a8675e85f82 100644 --- a/test/functional/apps/context/_filters.ts +++ b/test/functional/apps/context/_filters.ts @@ -19,19 +19,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const filterBar = getService('filterBar'); const testSubjects = getService('testSubjects'); const retry = getService('retry'); - const kibanaServer = getService('kibanaServer'); const PageObjects = getPageObjects(['common', 'context']); describe('context filters', function contextSize() { - before(async function () { - await kibanaServer.uiSettings.update({ 'doc_table:legacy': false }); - }); - - after(async function () { - await kibanaServer.uiSettings.replace({}); - }); - beforeEach(async function () { await PageObjects.context.navigateTo(TEST_INDEX_PATTERN, TEST_ANCHOR_ID, { columns: TEST_COLUMN_NAMES, diff --git a/test/functional/apps/context/_size.ts b/test/functional/apps/context/_size.ts index 563af7e07857e..853d4ebde79de 100644 --- a/test/functional/apps/context/_size.ts +++ b/test/functional/apps/context/_size.ts @@ -29,7 +29,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await kibanaServer.uiSettings.update({ 'context:defaultSize': `${TEST_DEFAULT_CONTEXT_SIZE}`, 'context:step': `${TEST_STEP_SIZE}`, - 'doc_table:legacy': false, }); await PageObjects.context.navigateTo(TEST_INDEX_PATTERN, TEST_ANCHOR_ID); }); diff --git a/test/functional/apps/discover/_context_encoded_url_params.ts b/test/functional/apps/discover/_context_encoded_url_params.ts index 293a1ee0b5e28..cff83b2d6f645 100644 --- a/test/functional/apps/discover/_context_encoded_url_params.ts +++ b/test/functional/apps/discover/_context_encoded_url_params.ts @@ -41,7 +41,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.common.navigateToApp('discover'); }); - it('should navigate correctly when ', async () => { + it('should navigate correctly', async () => { await PageObjects.discover.selectIndexPattern('context-encoded-param'); await PageObjects.header.waitUntilLoadingHasFinished(); await PageObjects.discover.waitForDocTableLoadingComplete(); diff --git a/test/functional/apps/discover/_data_grid.ts b/test/functional/apps/discover/_data_grid.ts index 198691f3b8477..96085f09186f6 100644 --- a/test/functional/apps/discover/_data_grid.ts +++ b/test/functional/apps/discover/_data_grid.ts @@ -19,7 +19,7 @@ export default function ({ const esArchiver = getService('esArchiver'); const PageObjects = getPageObjects(['common', 'discover', 'timePicker']); const kibanaServer = getService('kibanaServer'); - const defaultSettings = { defaultIndex: 'logstash-*', 'doc_table:legacy': false }; + const defaultSettings = { defaultIndex: 'logstash-*' }; const testSubjects = getService('testSubjects'); before(async function () { @@ -31,10 +31,6 @@ export default function ({ await PageObjects.timePicker.setDefaultAbsoluteRange(); }); - after(async function () { - await kibanaServer.uiSettings.replace({ 'doc_table:legacy': true }); - }); - it('can add fields to the table', async function () { const getTitles = async () => (await testSubjects.getVisibleText('dataGridHeader')).replace(/\s|\r?\n|\r/g, ' '); diff --git a/test/functional/apps/discover/_data_grid_context.ts b/test/functional/apps/discover/_data_grid_context.ts index d12ada2070cff..c2628026dfdda 100644 --- a/test/functional/apps/discover/_data_grid_context.ts +++ b/test/functional/apps/discover/_data_grid_context.ts @@ -27,7 +27,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { 'dashboard', 'header', ]); - const defaultSettings = { defaultIndex: 'logstash-*', 'doc_table:legacy': false }; + const defaultSettings = { defaultIndex: 'logstash-*' }; const kibanaServer = getService('kibanaServer'); const esArchiver = getService('esArchiver'); const dashboardAddPanel = getService('dashboardAddPanel'); diff --git a/test/functional/apps/discover/_data_grid_copy_to_clipboard.ts b/test/functional/apps/discover/_data_grid_copy_to_clipboard.ts index f202595729cfb..ec359e3c569db 100644 --- a/test/functional/apps/discover/_data_grid_copy_to_clipboard.ts +++ b/test/functional/apps/discover/_data_grid_copy_to_clipboard.ts @@ -19,7 +19,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const PageObjects = getPageObjects(['common', 'discover', 'header', 'timePicker', 'dashboard']); const defaultSettings = { defaultIndex: 'logstash-*', - 'doc_table:legacy': false, }; describe('discover data grid supports copy to clipboard', function describeIndexTests() { diff --git a/test/functional/apps/discover/_data_grid_doc_navigation.ts b/test/functional/apps/discover/_data_grid_doc_navigation.ts index 2da6db97aa13f..3c5c8b3967cb0 100644 --- a/test/functional/apps/discover/_data_grid_doc_navigation.ts +++ b/test/functional/apps/discover/_data_grid_doc_navigation.ts @@ -17,7 +17,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const esArchiver = getService('esArchiver'); const retry = getService('retry'); const kibanaServer = getService('kibanaServer'); - const defaultSettings = { defaultIndex: 'logstash-*', 'doc_table:legacy': false }; + const defaultSettings = { defaultIndex: 'logstash-*' }; describe('discover data grid doc link', function () { before(async () => { diff --git a/test/functional/apps/discover/_data_grid_doc_table.ts b/test/functional/apps/discover/_data_grid_doc_table.ts index bb0cd56298c20..6918edc8285d8 100644 --- a/test/functional/apps/discover/_data_grid_doc_table.ts +++ b/test/functional/apps/discover/_data_grid_doc_table.ts @@ -21,7 +21,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const PageObjects = getPageObjects(['common', 'discover', 'header', 'timePicker', 'dashboard']); const defaultSettings = { defaultIndex: 'logstash-*', - 'doc_table:legacy': false, }; const testSubjects = getService('testSubjects'); diff --git a/test/functional/apps/discover/_data_grid_field_data.ts b/test/functional/apps/discover/_data_grid_field_data.ts index 4a4e06e28c321..84d1c81f8ee68 100644 --- a/test/functional/apps/discover/_data_grid_field_data.ts +++ b/test/functional/apps/discover/_data_grid_field_data.ts @@ -16,7 +16,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const toasts = getService('toasts'); const queryBar = getService('queryBar'); const PageObjects = getPageObjects(['common', 'header', 'discover', 'visualize', 'timePicker']); - const defaultSettings = { defaultIndex: 'logstash-*', 'doc_table:legacy': false }; + const defaultSettings = { defaultIndex: 'logstash-*' }; const dataGrid = getService('dataGrid'); describe('discover data grid field data tests', function describeIndexTests() { diff --git a/test/functional/apps/discover/_data_grid_pagination.ts b/test/functional/apps/discover/_data_grid_pagination.ts index da9faa24bb151..7b0fc40e94ab8 100644 --- a/test/functional/apps/discover/_data_grid_pagination.ts +++ b/test/functional/apps/discover/_data_grid_pagination.ts @@ -14,7 +14,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const kibanaServer = getService('kibanaServer'); const dataGrid = getService('dataGrid'); const PageObjects = getPageObjects(['settings', 'common', 'discover', 'header', 'timePicker']); - const defaultSettings = { defaultIndex: 'logstash-*', 'doc_table:legacy': false }; + const defaultSettings = { defaultIndex: 'logstash-*' }; const testSubjects = getService('testSubjects'); const retry = getService('retry'); diff --git a/test/functional/apps/discover/_discover_fields_api.ts b/test/functional/apps/discover/_discover_fields_api.ts index fb3ee3b9858d3..e64280c1977b5 100644 --- a/test/functional/apps/discover/_discover_fields_api.ts +++ b/test/functional/apps/discover/_discover_fields_api.ts @@ -14,11 +14,11 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const retry = getService('retry'); const esArchiver = getService('esArchiver'); const kibanaServer = getService('kibanaServer'); + const dataGrid = getService('dataGrid'); const PageObjects = getPageObjects(['common', 'discover', 'header', 'timePicker', 'settings']); const defaultSettings = { defaultIndex: 'logstash-*', 'discover:searchFieldsFromSource': false, - 'doc_table:legacy': true, }; describe('discover uses fields API test', function describeIndexTests() { before(async function () { @@ -60,7 +60,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('displays _source viewer in doc viewer', async function () { - await PageObjects.discover.clickDocTableRowToggle(0); + await dataGrid.clickRowToggle(); await PageObjects.discover.isShowingDocViewer(); await PageObjects.discover.clickDocViewerTab(1); await PageObjects.discover.expectSourceViewerToExist(); @@ -74,7 +74,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.common.navigateToApp('discover'); await PageObjects.timePicker.setDefaultAbsoluteRange(); - expect(await PageObjects.discover.getDocHeader()).to.have.string('_source'); + expect(await PageObjects.discover.getDocHeader()).to.have.string('Document'); }); it('switches to Document column when fields API is used', async function () { diff --git a/test/functional/apps/discover/_field_data.ts b/test/functional/apps/discover/_field_data.ts index d13baf9948171..27b786a2abfc1 100644 --- a/test/functional/apps/discover/_field_data.ts +++ b/test/functional/apps/discover/_field_data.ts @@ -18,8 +18,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const queryBar = getService('queryBar'); const browser = getService('browser'); const PageObjects = getPageObjects(['common', 'header', 'discover', 'visualize', 'timePicker']); - const find = getService('find'); - const testSubjects = getService('testSubjects'); describe('discover tab', function describeIndexTests() { this.tags('includeFirefox'); @@ -97,38 +95,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const marks = await PageObjects.discover.getMarks(); expect(marks.length).to.be(0); }); - - describe('legacy table tests', async function () { - before(async function () { - await kibanaServer.uiSettings.update({ 'doc_table:legacy': true }); - await PageObjects.common.navigateToApp('discover'); - }); - - after(async function () { - await kibanaServer.uiSettings.replace({}); - }); - it('doc view should show @timestamp and _source columns', async function () { - const expectedHeader = '@timestamp\n_source'; - const docHeader = await find.byCssSelector('thead > tr:nth-child(1)'); - const docHeaderText = await docHeader.getVisibleText(); - expect(docHeaderText).to.be(expectedHeader); - }); - - it('doc view should sort ascending', async function () { - const expectedTimeStamp = 'Sep 20, 2015 @ 00:00:00.000'; - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); - - // we don't technically need this sleep here because the tryForTime will retry and the - // results will match on the 2nd or 3rd attempt, but that debug output is huge in this - // case and it can be avoided with just a few seconds sleep. - await PageObjects.common.sleep(2000); - await retry.try(async function tryingForTime() { - const row = await find.byCssSelector(`tr.kbnDocTable__row:nth-child(1)`); - const rowData = await row.getVisibleText(); - expect(rowData.startsWith(expectedTimeStamp)).to.be.ok(); - }); - }); - }); }); }); } diff --git a/test/functional/apps/discover/_field_data_with_fields_api.ts b/test/functional/apps/discover/_field_data_with_fields_api.ts index d7912d6d0959f..85bb26df24129 100644 --- a/test/functional/apps/discover/_field_data_with_fields_api.ts +++ b/test/functional/apps/discover/_field_data_with_fields_api.ts @@ -18,8 +18,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const queryBar = getService('queryBar'); const browser = getService('browser'); const PageObjects = getPageObjects(['common', 'header', 'discover', 'visualize', 'timePicker']); - const find = getService('find'); - const testSubjects = getService('testSubjects'); describe('discover tab with new fields API', function describeIndexTests() { this.tags('includeFirefox'); @@ -104,33 +102,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(marks.length).to.be.above(0); expect(marks).to.contain('election'); }); - - describe('legacy table tests', async function () { - before(async function () { - await kibanaServer.uiSettings.update({ 'doc_table:legacy': true }); - await PageObjects.common.navigateToApp('discover'); - }); - - after(async function () { - await kibanaServer.uiSettings.replace({}); - }); - - it('doc view should sort ascending', async function () { - const expectedTimeStamp = 'Sep 20, 2015 @ 00:00:00.000'; - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); - - // we don't technically need this sleep here because the tryForTime will retry and the - // results will match on the 2nd or 3rd attempt, but that debug output is huge in this - // case and it can be avoided with just a few seconds sleep. - await PageObjects.common.sleep(2000); - await retry.try(async function tryingForTime() { - const row = await find.byCssSelector(`tr.kbnDocTable__row:nth-child(1)`); - const rowData = await row.getVisibleText(); - - expect(rowData.startsWith(expectedTimeStamp)).to.be.ok(); - }); - }); - }); }); }); } diff --git a/test/functional/apps/discover/_classic_table_doc_navigation.ts b/test/functional/apps/discover/classic/_classic_table_doc_navigation.ts similarity index 97% rename from test/functional/apps/discover/_classic_table_doc_navigation.ts rename to test/functional/apps/discover/classic/_classic_table_doc_navigation.ts index c768d9600c189..a27d3df81d32f 100644 --- a/test/functional/apps/discover/_classic_table_doc_navigation.ts +++ b/test/functional/apps/discover/classic/_classic_table_doc_navigation.ts @@ -8,7 +8,7 @@ import expect from '@kbn/expect'; -import { FtrProviderContext } from '../../ftr_provider_context'; +import { FtrProviderContext } from '../../../ftr_provider_context'; export default function ({ getService, getPageObjects }: FtrProviderContext) { const docTable = getService('docTable'); diff --git a/test/functional/apps/discover/classic/_discover_fields_api.ts b/test/functional/apps/discover/classic/_discover_fields_api.ts new file mode 100644 index 0000000000000..7108cc2911be8 --- /dev/null +++ b/test/functional/apps/discover/classic/_discover_fields_api.ts @@ -0,0 +1,91 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const log = getService('log'); + const retry = getService('retry'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'discover', 'header', 'timePicker', 'settings']); + const defaultSettings = { + defaultIndex: 'logstash-*', + 'discover:searchFieldsFromSource': false, + 'doc_table:legacy': true, + }; + describe('discover uses fields API test', function describeIndexTests() { + before(async function () { + log.debug('load kibana index with default index pattern'); + await kibanaServer.savedObjects.clean({ types: ['search', 'index-pattern'] }); + await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover.json'); + await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.uiSettings.replace(defaultSettings); + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setDefaultAbsoluteRange(); + }); + + after(async () => { + await kibanaServer.uiSettings.replace({}); + }); + + it('should correctly display documents', async function () { + log.debug('check if Document title exists in the grid'); + expect(await PageObjects.discover.getDocHeader()).to.have.string('Document'); + const rowData = await PageObjects.discover.getDocTableIndex(1); + log.debug('check the newest doc timestamp in UTC (check diff timezone in last test)'); + expect(rowData.startsWith('Sep 22, 2015 @ 23:50:13.253')).to.be.ok(); + const expectedHitCount = '14,004'; + await retry.try(async function () { + expect(await PageObjects.discover.getHitCount()).to.be(expectedHitCount); + }); + }); + + it('adding a column removes a default column', async function () { + await PageObjects.discover.clickFieldListItemAdd('_score'); + expect(await PageObjects.discover.getDocHeader()).to.have.string('_score'); + expect(await PageObjects.discover.getDocHeader()).not.to.have.string('Document'); + }); + + it('removing a column adds a default column', async function () { + await PageObjects.discover.clickFieldListItemRemove('_score'); + expect(await PageObjects.discover.getDocHeader()).not.to.have.string('_score'); + expect(await PageObjects.discover.getDocHeader()).to.have.string('Document'); + }); + + it('displays _source viewer in doc viewer', async function () { + await PageObjects.discover.clickDocTableRowToggle(0); + await PageObjects.discover.isShowingDocViewer(); + await PageObjects.discover.clickDocViewerTab(1); + await PageObjects.discover.expectSourceViewerToExist(); + }); + + it('switches to _source column when fields API is no longer used', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaSettings(); + await PageObjects.settings.toggleAdvancedSettingCheckbox('discover:searchFieldsFromSource'); + + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setDefaultAbsoluteRange(); + + expect(await PageObjects.discover.getDocHeader()).to.have.string('_source'); + }); + + it('switches to Document column when fields API is used', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaSettings(); + await PageObjects.settings.toggleAdvancedSettingCheckbox('discover:searchFieldsFromSource'); + + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setDefaultAbsoluteRange(); + + expect(await PageObjects.discover.getDocHeader()).to.have.string('Document'); + }); + }); +} diff --git a/test/functional/apps/discover/_doc_table.ts b/test/functional/apps/discover/classic/_doc_table.ts similarity index 98% rename from test/functional/apps/discover/_doc_table.ts rename to test/functional/apps/discover/classic/_doc_table.ts index 321c41b92e9be..bfc813f2d822e 100644 --- a/test/functional/apps/discover/_doc_table.ts +++ b/test/functional/apps/discover/classic/_doc_table.ts @@ -7,7 +7,7 @@ */ import expect from '@kbn/expect'; -import { FtrProviderContext } from '../../ftr_provider_context'; +import { FtrProviderContext } from '../ftr_provider_context'; export default function ({ getService, getPageObjects }: FtrProviderContext) { const browser = getService('browser'); @@ -40,6 +40,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.common.navigateToApp('discover'); }); + after(async function () { + await kibanaServer.uiSettings.replace({}); + }); + it('should show records by default', async function () { // with the default range the number of hits is ~14000 const rows = await PageObjects.discover.getDocTableRows(); diff --git a/test/functional/apps/discover/_doc_table_newline.ts b/test/functional/apps/discover/classic/_doc_table_newline.ts similarity index 92% rename from test/functional/apps/discover/_doc_table_newline.ts rename to test/functional/apps/discover/classic/_doc_table_newline.ts index a02d31d5c76f4..112fff800cd41 100644 --- a/test/functional/apps/discover/_doc_table_newline.ts +++ b/test/functional/apps/discover/classic/_doc_table_newline.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { FtrProviderContext } from '../../ftr_provider_context'; +import { FtrProviderContext } from '../ftr_provider_context'; export default function ({ getService, getPageObjects }: FtrProviderContext) { const esArchiver = getService('esArchiver'); @@ -35,8 +35,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await security.testUser.restoreDefaults(); await esArchiver.unload('test/functional/fixtures/es_archiver/message_with_newline'); await kibanaServer.savedObjects.cleanStandardList(); - await kibanaServer.uiSettings.unset('defaultIndex'); - await kibanaServer.uiSettings.unset('doc_table:legacy'); + await kibanaServer.uiSettings.replace({}); }); it('should break text on newlines', async function () { @@ -47,6 +46,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const heightWithoutNewline = await dscTableRows[0].getAttribute('clientHeight'); const heightWithNewline = await dscTableRows[1].getAttribute('clientHeight'); log.debug(`Without newlines: ${heightWithoutNewline}, With newlines: ${heightWithNewline}`); + + await PageObjects.common.sleep(10000); return Number(heightWithNewline) > Number(heightWithoutNewline); }); }); diff --git a/test/functional/apps/discover/classic/_field_data.ts b/test/functional/apps/discover/classic/_field_data.ts new file mode 100644 index 0000000000000..f574a36dea028 --- /dev/null +++ b/test/functional/apps/discover/classic/_field_data.ts @@ -0,0 +1,62 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; + +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const retry = getService('retry'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header', 'discover', 'visualize', 'timePicker']); + const find = getService('find'); + const testSubjects = getService('testSubjects'); + + describe('discover tab', function describeIndexTests() { + this.tags('includeFirefox'); + before(async function () { + await kibanaServer.savedObjects.clean({ types: ['search', 'index-pattern'] }); + await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover.json'); + await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.uiSettings.replace({ + defaultIndex: 'logstash-*', + 'discover:searchFieldsFromSource': true, + 'doc_table:legacy': true, + }); + await PageObjects.timePicker.setDefaultAbsoluteRangeViaUiSettings(); + await PageObjects.common.navigateToApp('discover'); + }); + + after(async function () { + await kibanaServer.uiSettings.replace({}); + }); + + it('doc view should show @timestamp and _source columns', async function () { + const expectedHeader = '@timestamp\n_source'; + const docHeader = await find.byCssSelector('thead > tr:nth-child(1)'); + const docHeaderText = await docHeader.getVisibleText(); + expect(docHeaderText).to.be(expectedHeader); + }); + + it('doc view should sort ascending', async function () { + const expectedTimeStamp = 'Sep 20, 2015 @ 00:00:00.000'; + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + + // we don't technically need this sleep here because the tryForTime will retry and the + // results will match on the 2nd or 3rd attempt, but that debug output is huge in this + // case and it can be avoided with just a few seconds sleep. + await PageObjects.common.sleep(2000); + await retry.try(async function tryingForTime() { + const row = await find.byCssSelector(`tr.kbnDocTable__row:nth-child(1)`); + const rowData = await row.getVisibleText(); + expect(rowData.startsWith(expectedTimeStamp)).to.be.ok(); + }); + }); + }); +} diff --git a/test/functional/apps/discover/classic/_field_data_with_fields_api.ts b/test/functional/apps/discover/classic/_field_data_with_fields_api.ts new file mode 100644 index 0000000000000..efa680bfbfa3a --- /dev/null +++ b/test/functional/apps/discover/classic/_field_data_with_fields_api.ts @@ -0,0 +1,46 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; + +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const retry = getService('retry'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header', 'discover', 'visualize', 'timePicker']); + const find = getService('find'); + const testSubjects = getService('testSubjects'); + + describe('discover tab with new fields API', function describeIndexTests() { + before(async function () { + await kibanaServer.uiSettings.update({ 'doc_table:legacy': true }); + await PageObjects.common.navigateToApp('discover'); + }); + + after(async function () { + await kibanaServer.uiSettings.replace({}); + }); + + it('doc view should sort ascending', async function () { + const expectedTimeStamp = 'Sep 20, 2015 @ 00:00:00.000'; + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + + // we don't technically need this sleep here because the tryForTime will retry and the + // results will match on the 2nd or 3rd attempt, but that debug output is huge in this + // case and it can be avoided with just a few seconds sleep. + await PageObjects.common.sleep(2000); + await retry.try(async function tryingForTime() { + const row = await find.byCssSelector(`tr.kbnDocTable__row:nth-child(1)`); + const rowData = await row.getVisibleText(); + + expect(rowData.startsWith(expectedTimeStamp)).to.be.ok(); + }); + }); + }); +} diff --git a/test/functional/apps/discover/index.ts b/test/functional/apps/discover/index.ts index db72e270fd337..cd2742abe8e13 100644 --- a/test/functional/apps/discover/index.ts +++ b/test/functional/apps/discover/index.ts @@ -30,21 +30,24 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./_discover')); loadTestFile(require.resolve('./_discover_accessibility')); loadTestFile(require.resolve('./_discover_histogram')); - loadTestFile(require.resolve('./_doc_table')); - loadTestFile(require.resolve('./_doc_table_newline')); + loadTestFile(require.resolve('./classic/_doc_table')); + loadTestFile(require.resolve('./classic/_doc_table_newline')); loadTestFile(require.resolve('./_filter_editor')); loadTestFile(require.resolve('./_errors')); loadTestFile(require.resolve('./_field_data')); + loadTestFile(require.resolve('./classic/_field_data')); loadTestFile(require.resolve('./_field_data_with_fields_api')); + loadTestFile(require.resolve('./classic/_field_data_with_fields_api')); loadTestFile(require.resolve('./_shared_links')); loadTestFile(require.resolve('./_sidebar')); loadTestFile(require.resolve('./_source_filters')); loadTestFile(require.resolve('./_large_string')); loadTestFile(require.resolve('./_inspector')); - loadTestFile(require.resolve('./_classic_table_doc_navigation')); + loadTestFile(require.resolve('./classic/_classic_table_doc_navigation')); loadTestFile(require.resolve('./_date_nanos')); loadTestFile(require.resolve('./_date_nanos_mixed')); loadTestFile(require.resolve('./_indexpattern_without_timefield')); + loadTestFile(require.resolve('./classic/_discover_fields_api')); loadTestFile(require.resolve('./_discover_fields_api')); loadTestFile(require.resolve('./_data_grid')); loadTestFile(require.resolve('./_data_grid_context')); diff --git a/test/functional/apps/kibana_overview/_analytics.ts b/test/functional/apps/kibana_overview/_analytics.ts new file mode 100644 index 0000000000000..296256d924b24 --- /dev/null +++ b/test/functional/apps/kibana_overview/_analytics.ts @@ -0,0 +1,63 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; +import { WebElementWrapper } from '../../services/lib/web_element_wrapper'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const find = getService('find'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header']); + + describe('overview page - Analytics apps', function describeIndexTests() { + before(async () => { + await esArchiver.load('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + }); + + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + }); + + const apps = ['dashboard', 'discover', 'canvas', 'maps', 'ml']; + + it('should display Analytics apps cards', async () => { + const kbnOverviewAppsCards = await find.allByCssSelector('.kbnOverviewApps__item'); + expect(kbnOverviewAppsCards.length).to.be(apps.length); + + const verifyImageUrl = async (el: WebElementWrapper, imgName: string) => { + const image = await el.findByCssSelector('img'); + const imageUrl = await image.getAttribute('src'); + expect(imageUrl.includes(imgName)).to.be(true); + }; + + for (let i = 0; i < apps.length; i++) { + verifyImageUrl(kbnOverviewAppsCards[i], `kibana_${apps[i]}_light.svg`); + } + }); + + it('click on a card should lead to the appropriate app', async () => { + const kbnOverviewAppsCards = await find.allByCssSelector('.kbnOverviewApps__item'); + const dashboardCard = kbnOverviewAppsCards.at(0); + expect(dashboardCard).not.to.be(undefined); + if (dashboardCard) { + await dashboardCard.click(); + await PageObjects.common.waitUntilUrlIncludes('app/dashboards'); + } + }); + }); +} diff --git a/test/functional/apps/kibana_overview/_footer.ts b/test/functional/apps/kibana_overview/_footer.ts new file mode 100644 index 0000000000000..c44d399154f14 --- /dev/null +++ b/test/functional/apps/kibana_overview/_footer.ts @@ -0,0 +1,55 @@ +/* + * 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. + */ +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const find = getService('find'); + const esArchiver = getService('esArchiver'); + const retry = getService('retry'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header']); + + const defaultSettings = { + default_route: 'app/home', + }; + + describe('overview page - footer', function describeIndexTests() { + before(async () => { + await esArchiver.load('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + await kibanaServer.uiSettings.replace(defaultSettings); + }); + + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await kibanaServer.uiSettings.replace(defaultSettings); + }); + + it('clicking footer updates landing page', async () => { + await PageObjects.header.waitUntilLoadingHasFinished(); + let footerButton = await find.byCssSelector('.kbnOverviewPageFooter__button'); + await footerButton.click(); + + await retry.try(async () => { + footerButton = await find.byCssSelector('.kbnOverviewPageFooter__button'); + const text = await ( + await footerButton.findByCssSelector('.euiButtonEmpty__text') + ).getVisibleText(); + expect(text.toString().includes('Display a different page on log in')).to.be(true); + }); + }); + }); +} diff --git a/test/functional/apps/kibana_overview/_no_data.ts b/test/functional/apps/kibana_overview/_no_data.ts new file mode 100644 index 0000000000000..8dec616eb8afe --- /dev/null +++ b/test/functional/apps/kibana_overview/_no_data.ts @@ -0,0 +1,42 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const find = getService('find'); + const testSubjects = getService('testSubjects'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header']); + + describe('overview page - no data', function describeIndexTests() { + before(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + kibanaServer.savedObjects.clean({ types: ['index-pattern'] }); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + }); + + it('should display no data page', async () => { + await PageObjects.header.waitUntilLoadingHasFinished(); + const exists = await find.byClassName('kbnNoDataPageContents'); + expect(exists).not.to.be(undefined); + }); + + it('click on add data opens integrations', async () => { + const addIntegrations = await testSubjects.find('kbnOverviewAddIntegrations'); + await addIntegrations.click(); + await PageObjects.common.waitUntilUrlIncludes('integrations/browse'); + }); + }); +} diff --git a/test/functional/apps/kibana_overview/_page_header.ts b/test/functional/apps/kibana_overview/_page_header.ts new file mode 100644 index 0000000000000..8c254948676fc --- /dev/null +++ b/test/functional/apps/kibana_overview/_page_header.ts @@ -0,0 +1,69 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const find = getService('find'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const PageObjects = getPageObjects(['common', 'header', 'dashboard']); + + describe('overview page - page header', function describeIndexTests() { + before(async () => { + await esArchiver.load('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + }); + + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + }); + + it('click on integrations leads to integrations', async () => { + const headerItems = await find.byCssSelector('.euiPageHeaderContent__rightSideItems'); + const items = await headerItems.findAllByCssSelector('.kbnRedirectCrossAppLinks'); + expect(items!.length).to.be(3); + + const integrations = await items!.at(0); + await integrations!.click(); + await PageObjects.common.waitUntilUrlIncludes('app/integrations/browse'); + }); + + it('click on management leads to management', async () => { + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + const headerItems = await find.byCssSelector('.euiPageHeaderContent__rightSideItems'); + const items = await headerItems.findAllByCssSelector('.kbnRedirectCrossAppLinks'); + + const management = await items!.at(1); + await management!.click(); + await PageObjects.common.waitUntilUrlIncludes('app/management'); + }); + + it('click on dev tools leads to dev tools', async () => { + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + const headerItems = await find.byCssSelector('.euiPageHeaderContent__rightSideItems'); + const items = await headerItems.findAllByCssSelector('.kbnRedirectCrossAppLinks'); + + const devTools = await items!.at(2); + await devTools!.click(); + await PageObjects.common.waitUntilUrlIncludes('app/dev_tools'); + }); + }); +} diff --git a/test/functional/apps/kibana_overview/_solutions.ts b/test/functional/apps/kibana_overview/_solutions.ts new file mode 100644 index 0000000000000..97af7f7242eff --- /dev/null +++ b/test/functional/apps/kibana_overview/_solutions.ts @@ -0,0 +1,72 @@ +/* + * 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. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const find = getService('find'); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const retry = getService('retry'); + const PageObjects = getPageObjects(['common', 'header']); + + describe('overview page - solutions', function describeIndexTests() { + before(async () => { + await esArchiver.load('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.load( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + }); + + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + await kibanaServer.importExport.unload( + 'test/functional/fixtures/kbn_archiver/kibana_sample_data_flights_index_pattern' + ); + }); + + it('contains the appropriate solutions', async () => { + const solutionCards = await find.allByCssSelector('.kbnOverviewMore__item'); + expect(solutionCards.length).to.be(2); + + const observabilityImage = await solutionCards[0].findByCssSelector('img'); + const observabilityImageUrl = await observabilityImage.getAttribute('src'); + expect(observabilityImageUrl.includes('/solutions_observability.svg')).to.be(true); + + const securityImage = await solutionCards[1].findByCssSelector('img'); + const securityImageUrl = await securityImage.getAttribute('src'); + expect(securityImageUrl.includes('/solutions_security_solution.svg')).to.be(true); + }); + + it('click on Observability card leads to Observability', async () => { + let solutionCards: string | any[] = []; + await retry.waitForWithTimeout('all solutions to be present', 5000, async () => { + solutionCards = await find.allByCssSelector('.kbnOverviewMore__item'); + return solutionCards.length === 2; + }); + await solutionCards[0].click(); + await PageObjects.common.waitUntilUrlIncludes('app/observability'); + }); + + it('click on Security card leads to Security', async () => { + await PageObjects.common.navigateToUrl('kibana_overview', '', { useActualUrl: true }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + let solutionCards: string | any[] = []; + await retry.waitForWithTimeout('all solutions to be present', 5000, async () => { + solutionCards = await find.allByCssSelector('.kbnOverviewMore__item'); + return solutionCards.length === 2; + }); + await solutionCards[1].click(); + await PageObjects.common.waitUntilUrlIncludes('app/security'); + }); + }); +} diff --git a/test/functional/apps/kibana_overview/config.ts b/test/functional/apps/kibana_overview/config.ts new file mode 100644 index 0000000000000..e487d31dcb657 --- /dev/null +++ b/test/functional/apps/kibana_overview/config.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. + */ + +import { FtrConfigProviderContext } from '@kbn/test'; + +export default async function ({ readConfigFile }: FtrConfigProviderContext) { + const functionalConfig = await readConfigFile(require.resolve('../../config.base.js')); + + return { + ...functionalConfig.getAll(), + testFiles: [require.resolve('.')], + }; +} diff --git a/test/functional/apps/kibana_overview/index.js b/test/functional/apps/kibana_overview/index.js new file mode 100644 index 0000000000000..40dd47f6b69ef --- /dev/null +++ b/test/functional/apps/kibana_overview/index.js @@ -0,0 +1,23 @@ +/* + * 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 default function ({ getService, loadTestFile }) { + const browser = getService('browser'); + + describe('kibana overview app', function () { + before(function () { + return browser.setWindowSize(1200, 800); + }); + + loadTestFile(require.resolve('./_no_data')); + loadTestFile(require.resolve('./_page_header')); + loadTestFile(require.resolve('./_analytics')); + loadTestFile(require.resolve('./_solutions')); + loadTestFile(require.resolve('./_footer')); + }); +} diff --git a/test/functional/apps/management/_scripted_fields.ts b/test/functional/apps/management/_scripted_fields.ts index a6bbe798cf56b..cefaa5b295369 100644 --- a/test/functional/apps/management/_scripted_fields.ts +++ b/test/functional/apps/management/_scripted_fields.ts @@ -32,6 +32,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const retry = getService('retry'); const testSubjects = getService('testSubjects'); const filterBar = getService('filterBar'); + const find = getService('find'); + const dataGrid = getService('dataGrid'); const PageObjects = getPageObjects([ 'common', 'header', @@ -48,7 +50,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await browser.setWindowSize(1200, 800); await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); await kibanaServer.uiSettings.replace({}); - await kibanaServer.uiSettings.update({ 'doc_table:legacy': true }); }); after(async function afterAll() { @@ -56,6 +57,16 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await kibanaServer.uiSettings.replace({}); }); + /** + * @param field field name to sort + * @param optionIndex index of the option to choose in dropdown + */ + const clickSort = async (field: string, optionIndex: number) => { + await testSubjects.click(`dataGridHeaderCell-${field}`); + const optionButtons = await find.allByCssSelector('.euiListGroupItem__button'); + await optionButtons[optionIndex].click(); + }; + it('should not allow saving of invalid scripts', async function () { await PageObjects.settings.navigateTo(); await PageObjects.settings.clickKibanaIndexPatterns(); @@ -146,29 +157,37 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\n18'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.91618'); }); }); // add a test to sort numeric scripted field it('should sort scripted field value in Discover', async function () { - await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName}`); + await clickSort(scriptedPainlessFieldName, 1); + await PageObjects.common.sleep(500); + // after the first click on the scripted field, it becomes secondary sort after time. // click on the timestamp twice to make it be the secondary sort key. - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await clickSort('@timestamp', 1); + await clickSort('@timestamp', 0); + await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 17, 2015 @ 10:53:14.181\n-1'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 17, 2015 @ 10:53:14.181-1'); }); - await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName}`); + await clickSort(scriptedPainlessFieldName, 2); + // after the first click on the scripted field, it becomes primary sort after time. + // click on the scripted field twice then, makes it be the secondary sort key. + await clickSort(scriptedPainlessFieldName, 2); + await clickSort(scriptedPainlessFieldName, 2); + await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.479\n20'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.47920'); }); }); @@ -233,29 +252,37 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\ngood'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916good'); }); }); // add a test to sort string scripted field it('should sort scripted field value in Discover', async function () { - await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await clickSort(scriptedPainlessFieldName2, 1); + // await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await PageObjects.common.sleep(500); + // after the first click on the scripted field, it becomes secondary sort after time. // click on the timestamp twice to make it be the secondary sort key. - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); - await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await clickSort('@timestamp', 1); + await clickSort('@timestamp', 0); await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 17, 2015 @ 09:48:40.594\nbad'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 17, 2015 @ 09:48:40.594bad'); }); - await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await clickSort(scriptedPainlessFieldName2, 2); + // after the first click on the scripted field, it becomes primary sort after time. + // click on the scripted field twice then, makes it be the secondary sort key. + await clickSort(scriptedPainlessFieldName2, 2); + await clickSort(scriptedPainlessFieldName2, 2); + await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.479\ngood'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.479good'); }); }); @@ -319,8 +346,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\ntrue'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916true'); }); }); @@ -406,8 +433,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.header.waitUntilLoadingHasFinished(); await retry.try(async function () { - const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); - expect(rowData).to.be('Sep 18, 2015 @ 06:52:55.953\n2015-09-18 07:00'); + const rowData = (await dataGrid.getRowsText())[0]; + expect(rowData).to.be('Sep 18, 2015 @ 06:52:55.9532015-09-18 07:00'); }); }); diff --git a/test/functional/apps/management/_scripted_fields_classic_table.ts b/test/functional/apps/management/_scripted_fields_classic_table.ts new file mode 100644 index 0000000000000..a6bbe798cf56b --- /dev/null +++ b/test/functional/apps/management/_scripted_fields_classic_table.ts @@ -0,0 +1,459 @@ +/* + * 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. + */ + +// Tests for 4 scripted fields; +// 1. Painless (number type) +// 2. Painless (string type) +// 3. Painless (boolean type) +// 4. Painless (date type) +// +// Each of these scripted fields has 4 tests (12 tests total); +// 1. Create scripted field +// 2. See the expected value of the scripted field in Discover doc view +// 3. Filter in Discover by the scripted field +// 4. Visualize with aggregation on the scripted field by clicking discover.clickFieldListItemVisualize + +// NOTE: Scripted field input is managed by Ace editor, which automatically +// appends closing braces, for exmaple, if you type opening square brace [ +// it will automatically insert a a closing square brace ], etc. + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const kibanaServer = getService('kibanaServer'); + const log = getService('log'); + const browser = getService('browser'); + const retry = getService('retry'); + const testSubjects = getService('testSubjects'); + const filterBar = getService('filterBar'); + const PageObjects = getPageObjects([ + 'common', + 'header', + 'settings', + 'visualize', + 'discover', + 'timePicker', + ]); + + describe('scripted fields', function () { + this.tags(['skipFirefox']); + + before(async function () { + await browser.setWindowSize(1200, 800); + await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); + await kibanaServer.uiSettings.replace({}); + await kibanaServer.uiSettings.update({ 'doc_table:legacy': true }); + }); + + after(async function afterAll() { + await kibanaServer.importExport.unload('test/functional/fixtures/kbn_archiver/discover'); + await kibanaServer.uiSettings.replace({}); + }); + + it('should not allow saving of invalid scripts', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + await PageObjects.settings.clickScriptedFieldsTab(); + await PageObjects.settings.clickAddScriptedField(); + await PageObjects.settings.setScriptedFieldName('doomedScriptedField'); + await PageObjects.settings.setScriptedFieldScript(`i n v a l i d s c r i p t`); + await PageObjects.settings.clickSaveScriptedField(); + await retry.try(async () => { + const invalidScriptErrorExists = await testSubjects.exists('invalidScriptError'); + expect(invalidScriptErrorExists).to.be(true); + }); + }); + + describe('testing regression for issue #33251', function describeIndexTests() { + const scriptedPainlessFieldName = 'ram_Pain_reg'; + + it('should create and edit scripted field', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + const startingCount = parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10); + await PageObjects.settings.clickScriptedFieldsTab(); + await log.debug('add scripted field'); + const script = `1`; + await PageObjects.settings.addScriptedField( + scriptedPainlessFieldName, + 'painless', + 'number', + null, + '1', + script + ); + await retry.try(async function () { + expect(parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10)).to.be( + startingCount + 1 + ); + }); + + for (let i = 0; i < 3; i++) { + await PageObjects.settings.editScriptedField(scriptedPainlessFieldName); + const fieldSaveButton = await testSubjects.exists('fieldSaveButton'); + expect(fieldSaveButton).to.be(true); + await PageObjects.settings.clickSaveScriptedField(); + } + }); + }); + + describe('creating and using Painless numeric scripted fields', function describeIndexTests() { + const scriptedPainlessFieldName = 'ram_Pain1'; + + it('should create scripted field', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + const startingCount = parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10); + await PageObjects.settings.clickScriptedFieldsTab(); + await log.debug('add scripted field'); + const script = `if (doc['machine.ram'].size() == 0) return -1; + else return doc['machine.ram'].value / (1024 * 1024 * 1024); + `; + await PageObjects.settings.addScriptedField( + scriptedPainlessFieldName, + 'painless', + 'number', + null, + '100', + script + ); + await retry.try(async function () { + expect(parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10)).to.be( + startingCount + 1 + ); + }); + }); + + it('should see scripted field value in Discover', async function () { + const fromTime = 'Sep 17, 2015 @ 06:31:44.000'; + const toTime = 'Sep 18, 2015 @ 18:31:44.000'; + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime); + + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName); + await retry.try(async function () { + await PageObjects.discover.clickFieldListItemAdd(scriptedPainlessFieldName); + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\n18'); + }); + }); + + // add a test to sort numeric scripted field + it('should sort scripted field value in Discover', async function () { + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName}`); + // after the first click on the scripted field, it becomes secondary sort after time. + // click on the timestamp twice to make it be the secondary sort key. + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 17, 2015 @ 10:53:14.181\n-1'); + }); + + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName}`); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.479\n20'); + }); + }); + + it('should filter by scripted field value in Discover', async function () { + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName); + await log.debug('filter by the first value (14) in the expanded scripted field list'); + await PageObjects.discover.clickFieldListPlusFilter(scriptedPainlessFieldName, '14'); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + expect(await PageObjects.discover.getHitCount()).to.be('31'); + }); + }); + + it('should visualize scripted field in vertical bar chart', async function () { + await filterBar.removeAllFilters(); + await PageObjects.discover.clickFieldListItemVisualize(scriptedPainlessFieldName); + await PageObjects.header.waitUntilLoadingHasFinished(); + // verify Lens opens a visualization + expect(await testSubjects.getVisibleTextAll('lns-dimensionTrigger')).to.contain( + '@timestamp', + 'Median of ram_Pain1' + ); + }); + }); + + describe('creating and using Painless string scripted fields', function describeIndexTests() { + const scriptedPainlessFieldName2 = 'painString'; + + it('should create scripted field', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + const startingCount = parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10); + await PageObjects.settings.clickScriptedFieldsTab(); + await log.debug('add scripted field'); + await PageObjects.settings.addScriptedField( + scriptedPainlessFieldName2, + 'painless', + 'string', + null, + '1', + "if (doc['response.raw'].value == '200') { return 'good'} else { return 'bad'}" + ); + await retry.try(async function () { + expect(parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10)).to.be( + startingCount + 1 + ); + }); + }); + + it('should see scripted field value in Discover', async function () { + const fromTime = 'Sep 17, 2015 @ 06:31:44.000'; + const toTime = 'Sep 18, 2015 @ 18:31:44.000'; + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime); + + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await retry.try(async function () { + await PageObjects.discover.clickFieldListItemAdd(scriptedPainlessFieldName2); + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\ngood'); + }); + }); + + // add a test to sort string scripted field + it('should sort scripted field value in Discover', async function () { + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + // after the first click on the scripted field, it becomes secondary sort after time. + // click on the timestamp twice to make it be the secondary sort key. + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 17, 2015 @ 09:48:40.594\nbad'); + }); + + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 17, 2015 @ 06:32:29.479\ngood'); + }); + }); + + it('should filter by scripted field value in Discover', async function () { + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await log.debug('filter by "bad" in the expanded scripted field list'); + await PageObjects.discover.clickFieldListPlusFilter(scriptedPainlessFieldName2, 'bad'); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + expect(await PageObjects.discover.getHitCount()).to.be('27'); + }); + await filterBar.removeAllFilters(); + }); + + it('should visualize scripted field in vertical bar chart', async function () { + await PageObjects.discover.clickFieldListItemVisualize(scriptedPainlessFieldName2); + await PageObjects.header.waitUntilLoadingHasFinished(); + // verify Lens opens a visualization + expect(await testSubjects.getVisibleTextAll('lns-dimensionTrigger')).to.contain( + 'Top 5 values of painString' + ); + }); + }); + + describe('creating and using Painless boolean scripted fields', function describeIndexTests() { + const scriptedPainlessFieldName2 = 'painBool'; + + it('should create scripted field', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + const startingCount = parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10); + await PageObjects.settings.clickScriptedFieldsTab(); + await log.debug('add scripted field'); + await PageObjects.settings.addScriptedField( + scriptedPainlessFieldName2, + 'painless', + 'boolean', + null, + '1', + "doc['response.raw'].value == '200'" + ); + await retry.try(async function () { + expect(parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10)).to.be( + startingCount + 1 + ); + }); + }); + + it('should see scripted field value in Discover', async function () { + const fromTime = 'Sep 17, 2015 @ 06:31:44.000'; + const toTime = 'Sep 18, 2015 @ 18:31:44.000'; + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime); + + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await retry.try(async function () { + await PageObjects.discover.clickFieldListItemAdd(scriptedPainlessFieldName2); + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 18, 2015 @ 18:20:57.916\ntrue'); + }); + }); + + it('should filter by scripted field value in Discover', async function () { + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await log.debug('filter by "true" in the expanded scripted field list'); + await PageObjects.discover.clickFieldListPlusFilter(scriptedPainlessFieldName2, 'true'); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + expect(await PageObjects.discover.getHitCount()).to.be('359'); + }); + await filterBar.removeAllFilters(); + }); + + // add a test to sort boolean + // existing bug: https://github.com/elastic/kibana/issues/75519 hence the issue is skipped. + it.skip('should sort scripted field value in Discover', async function () { + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + // after the first click on the scripted field, it becomes secondary sort after time. + // click on the timestamp twice to make it be the secondary sort key. + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('updateExpectedResultHere\ntrue'); + }); + + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('updateExpectedResultHere\nfalse'); + }); + }); + + it('should visualize scripted field in vertical bar chart', async function () { + await PageObjects.discover.clickFieldListItemVisualize(scriptedPainlessFieldName2); + await PageObjects.header.waitUntilLoadingHasFinished(); + // verify Lens opens a visualization + expect(await testSubjects.getVisibleTextAll('lns-dimensionTrigger')).to.contain( + 'Top 5 values of painBool' + ); + }); + }); + + describe('creating and using Painless date scripted fields', function describeIndexTests() { + const scriptedPainlessFieldName2 = 'painDate'; + + it('should create scripted field', async function () { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickKibanaIndexPatterns(); + await PageObjects.settings.clickIndexPatternLogstash(); + const startingCount = parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10); + await PageObjects.settings.clickScriptedFieldsTab(); + await log.debug('add scripted field'); + await PageObjects.settings.addScriptedField( + scriptedPainlessFieldName2, + 'painless', + 'date', + { format: 'date', datePattern: 'YYYY-MM-DD HH:00' }, + '1', + "doc['utc_time'].value.toEpochMilli() + (1000) * 60 * 60" + ); + await retry.try(async function () { + expect(parseInt(await PageObjects.settings.getScriptedFieldsTabCount(), 10)).to.be( + startingCount + 1 + ); + }); + }); + + it('should see scripted field value in Discover', async function () { + const fromTime = 'Sep 17, 2015 @ 19:22:00.000'; + const toTime = 'Sep 18, 2015 @ 07:00:00.000'; + await PageObjects.common.navigateToApp('discover'); + await PageObjects.timePicker.setAbsoluteRange(fromTime, toTime); + + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await retry.try(async function () { + await PageObjects.discover.clickFieldListItemAdd(scriptedPainlessFieldName2); + }); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('Sep 18, 2015 @ 06:52:55.953\n2015-09-18 07:00'); + }); + }); + + // add a test to sort date scripted field + // https://github.com/elastic/kibana/issues/75711 + it.skip('should sort scripted field value in Discover', async function () { + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + // after the first click on the scripted field, it becomes secondary sort after time. + // click on the timestamp twice to make it be the secondary sort key. + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await testSubjects.click('docTableHeaderFieldSort_@timestamp'); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('updateExpectedResultHere\n2015-09-18 07:00'); + }); + + await testSubjects.click(`docTableHeaderFieldSort_${scriptedPainlessFieldName2}`); + await PageObjects.header.waitUntilLoadingHasFinished(); + await retry.try(async function () { + const rowData = await PageObjects.discover.getDocTableIndexLegacy(1); + expect(rowData).to.be('updateExpectedResultHere\n2015-09-18 07:00'); + }); + }); + + it('should filter by scripted field value in Discover', async function () { + await PageObjects.discover.clickFieldListItem(scriptedPainlessFieldName2); + await log.debug('filter by "Sep 17, 2015 @ 23:00" in the expanded scripted field list'); + await PageObjects.discover.clickFieldListPlusFilter( + scriptedPainlessFieldName2, + '1442531297065' + ); + await PageObjects.header.waitUntilLoadingHasFinished(); + + await retry.try(async function () { + expect(await PageObjects.discover.getHitCount()).to.be('1'); + }); + await filterBar.removeAllFilters(); + }); + + it('should visualize scripted field in vertical bar chart', async function () { + await PageObjects.discover.clickFieldListItemVisualize(scriptedPainlessFieldName2); + await PageObjects.header.waitUntilLoadingHasFinished(); + // verify Lens opens a visualization + expect(await testSubjects.getVisibleTextAll('lns-dimensionTrigger')).to.contain('painDate'); + }); + }); + }); +} diff --git a/test/functional/apps/management/index.ts b/test/functional/apps/management/index.ts index 09f9001d0236a..48cb90393d372 100644 --- a/test/functional/apps/management/index.ts +++ b/test/functional/apps/management/index.ts @@ -30,6 +30,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./_mgmt_import_saved_objects')); loadTestFile(require.resolve('./_index_patterns_empty')); loadTestFile(require.resolve('./_scripted_fields')); + loadTestFile(require.resolve('./_scripted_fields_classic_table')); loadTestFile(require.resolve('./_runtime_fields')); loadTestFile(require.resolve('./_field_formatter')); loadTestFile(require.resolve('./_legacy_url_redirect')); diff --git a/test/functional/config.base.js b/test/functional/config.base.js index 147fef2685f5d..f7f210aa7de32 100644 --- a/test/functional/config.base.js +++ b/test/functional/config.base.js @@ -90,6 +90,9 @@ export default async function ({ readConfigFile }) { integrations: { pathname: '/app/integrations', }, + kibana_overview: { + pathname: '/app/kibana_overview', + }, }, junit: { reportName: 'Chrome UI Functional Tests', diff --git a/test/functional/page_objects/settings_page.ts b/test/functional/page_objects/settings_page.ts index bd3e259ef6291..306755823b822 100644 --- a/test/functional/page_objects/settings_page.ts +++ b/test/functional/page_objects/settings_page.ts @@ -51,6 +51,19 @@ export class SettingsPageObject extends FtrService { await this.header.waitUntilLoadingHasFinished(); } + async clickSnapshotRestore() { + await this.testSubjects.click('snapshot_restore'); + await this.header.waitUntilLoadingHasFinished(); + await this.retry.waitFor('snapshot restore header to be visible', async () => { + return (await this.testSubjects.getVisibleText('appTitle')) === 'Snapshot and Restore'; + }); + } + + async clickIndexManagement() { + await this.testSubjects.click('index_management'); + await this.header.waitUntilLoadingHasFinished(); + } + async getAdvancedSettings(propertyName: string) { this.log.debug('in getAdvancedSettings'); return await this.testSubjects.getAttribute( diff --git a/test/functional/page_objects/visual_builder_page.ts b/test/functional/page_objects/visual_builder_page.ts index da1253926a74d..377c844f7a446 100644 --- a/test/functional/page_objects/visual_builder_page.ts +++ b/test/functional/page_objects/visual_builder_page.ts @@ -936,7 +936,7 @@ export class VisualBuilderPageObject extends FtrService { public async getVisualizeError() { const visError = await this.testSubjects.find(`visualization-error`); - const errorSpans = await visError.findAllByClassName('euiText--extraSmall'); + const errorSpans = await visError.findAllByTestSubject('visualization-error-text'); return await errorSpans[0].getVisibleText(); } diff --git a/test/scripts/checks/doc_api_changes.sh b/test/scripts/checks/doc_api_changes.sh deleted file mode 100755 index f2f508fd8f7d4..0000000000000 --- a/test/scripts/checks/doc_api_changes.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/bin/env bash - -source src/dev/ci_setup/setup_env.sh - -checks-reporter-with-killswitch "Check Doc API Changes" \ - node scripts/check_published_api_changes diff --git a/test/scripts/jenkins_unit.sh b/test/scripts/jenkins_unit.sh index b852a5b313ad9..e0ff16f387e3d 100755 --- a/test/scripts/jenkins_unit.sh +++ b/test/scripts/jenkins_unit.sh @@ -16,7 +16,6 @@ if [[ -z "$CODE_COVERAGE" ]] ; then ./test/scripts/checks/telemetry.sh ./test/scripts/checks/ts_projects.sh ./test/scripts/checks/jest_configs.sh - ./test/scripts/checks/doc_api_changes.sh ./test/scripts/checks/type_check.sh ./test/scripts/checks/bundle_limits.sh ./test/scripts/checks/i18n.sh diff --git a/vars/tasks.groovy b/vars/tasks.groovy index ee440c9c11731..0f44ad0658043 100644 --- a/vars/tasks.groovy +++ b/vars/tasks.groovy @@ -8,7 +8,6 @@ def check() { kibanaPipeline.scriptTask('Check Telemetry Schema', 'test/scripts/checks/telemetry.sh'), kibanaPipeline.scriptTask('Check TypeScript Projects', 'test/scripts/checks/ts_projects.sh'), kibanaPipeline.scriptTask('Check Jest Configs', 'test/scripts/checks/jest_configs.sh'), - kibanaPipeline.scriptTask('Check Doc API Changes', 'test/scripts/checks/doc_api_changes.sh'), kibanaPipeline.scriptTask('Check @kbn/pm Distributable', 'test/scripts/checks/kbn_pm_dist.sh'), kibanaPipeline.scriptTask('Check Plugin List Docs', 'test/scripts/checks/plugin_list_docs.sh'), kibanaPipeline.scriptTask('Check Types and Public API Docs', 'test/scripts/checks/type_check_plugin_public_api_docs.sh'), diff --git a/x-pack/packages/ml/agg_utils/BUILD.bazel b/x-pack/packages/ml/agg_utils/BUILD.bazel new file mode 100644 index 0000000000000..0d59aca092fd5 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/BUILD.bazel @@ -0,0 +1,125 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "agg_utils" +PKG_REQUIRE_NAME = "@kbn/ml-agg-utils" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "@npm//@elastic/elasticsearch", + "@npm//lodash", + "//packages/kbn-field-types", + "//x-pack/packages/ml/is_populated_object", + "//x-pack/packages/ml/string_hash", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/lodash", + "@npm//@elastic/elasticsearch", + "@npm//tslib", + "//packages/kbn-field-types:npm_module_types", + "//x-pack/packages/ml/is_populated_object:npm_module_types", + "//x-pack/packages/ml/string_hash:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/x-pack/packages/ml/agg_utils/README.md b/x-pack/packages/ml/agg_utils/README.md new file mode 100644 index 0000000000000..63a30e1f1cbef --- /dev/null +++ b/x-pack/packages/ml/agg_utils/README.md @@ -0,0 +1,32 @@ +# @kbn/ml-agg-utils + +This package includes utility functions provided by the ML team to be used in Kibana plugins related to data manipulation and verification. + + + +### `buildSamplerAggregation` (function) + +Wraps the supplied aggregations in a sampler aggregation. +A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) +of less than 1 indicates no sampling, and the aggs are returned as-is. + +**Parameters:** + +- aggs (`any`) +- samplerShardSize (`number`) + +**returns:** Record + +### `getSamplerAggregationsResponsePath` (function) + +**Parameters:** + +- samplerShardSize (`number`) + +**returns:** string[] + +### `getAggIntervals` (function) + +Returns aggregation intervals for the supplied document fields. + + diff --git a/x-pack/packages/ml/agg_utils/jest.config.js b/x-pack/packages/ml/agg_utils/jest.config.js new file mode 100644 index 0000000000000..a22a76d5bf951 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/jest.config.js @@ -0,0 +1,12 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/x-pack/packages/ml/agg_utils'], +}; diff --git a/x-pack/packages/ml/agg_utils/package.json b/x-pack/packages/ml/agg_utils/package.json new file mode 100644 index 0000000000000..11f2fe9d4d450 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/package.json @@ -0,0 +1,13 @@ +{ + "name": "@kbn/ml-agg-utils", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "devDependencies": { + "ts-readme": "^1.1.3" + }, + "scripts": { + "generate-docs": "ts-readme src/index.ts" + } +} diff --git a/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.test.ts b/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.test.ts new file mode 100644 index 0000000000000..c792b331ef5b2 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.test.ts @@ -0,0 +1,31 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { buildSamplerAggregation } from './build_sampler_aggregation'; + +describe('buildSamplerAggregation', () => { + const testAggs = { + bytes_stats: { + stats: { field: 'bytes' }, + }, + }; + + test('returns wrapped sampler aggregation for sampler shard size of 1000', () => { + expect(buildSamplerAggregation(testAggs, 1000)).toEqual({ + sample: { + sampler: { + shard_size: 1000, + }, + aggs: testAggs, + }, + }); + }); + + test('returns un-sampled aggregation as-is for sampler shard size of 0', () => { + expect(buildSamplerAggregation(testAggs, 0)).toEqual(testAggs); + }); +}); diff --git a/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts b/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts new file mode 100644 index 0000000000000..30345b00caf2f --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts @@ -0,0 +1,31 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +/** + * Wraps the supplied aggregations in a sampler aggregation. + * A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) + * of less than 1 indicates no sampling, and the aggs are returned as-is. + */ +export function buildSamplerAggregation( + aggs: any, + samplerShardSize: number +): Record { + if (samplerShardSize < 1) { + return aggs; + } + + return { + sample: { + sampler: { + shard_size: samplerShardSize, + }, + aggs, + }, + }; +} diff --git a/x-pack/packages/ml/agg_utils/src/get_agg_intervals.ts b/x-pack/packages/ml/agg_utils/src/get_agg_intervals.ts new file mode 100644 index 0000000000000..67a6f28497d6e --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/get_agg_intervals.ts @@ -0,0 +1,107 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { get } from 'lodash'; + +import type { Client } from '@elastic/elasticsearch'; +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +import { KBN_FIELD_TYPES } from '@kbn/field-types'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; +import { stringHash } from '@kbn/ml-string-hash'; + +import { buildSamplerAggregation } from './build_sampler_aggregation'; +import { getSamplerAggregationsResponsePath } from './get_sampler_aggregations_response_path'; + +// TODO Temporary type definition until we can import from `@kbn/core`. +// Copied from src/core/server/elasticsearch/client/types.ts +// as these types aren't part of any package yet. Once they are, remove this completely + +/** + * Client used to query the elasticsearch cluster. + * @deprecated At some point use the one from src/core/server/elasticsearch/client/types.ts when it is made into a package. If it never is, then keep using this one. + * @public + */ +type ElasticsearchClient = Omit< + Client, + 'connectionPool' | 'serializer' | 'extend' | 'close' | 'diagnostic' +>; + +const MAX_CHART_COLUMNS = 20; + +interface HistogramField { + fieldName: string; + type: string; +} + +interface NumericColumnStats { + interval: number; + min: number; + max: number; +} +type NumericColumnStatsMap = Record; + +/** + * Returns aggregation intervals for the supplied document fields. + */ +export const getAggIntervals = async ( + client: ElasticsearchClient, + indexPattern: string, + query: estypes.QueryDslQueryContainer, + fields: HistogramField[], + samplerShardSize: number, + runtimeMappings?: estypes.MappingRuntimeFields +): Promise => { + const numericColumns = fields.filter((field) => { + return field.type === KBN_FIELD_TYPES.NUMBER || field.type === KBN_FIELD_TYPES.DATE; + }); + + if (numericColumns.length === 0) { + return {}; + } + + const minMaxAggs = numericColumns.reduce((aggs, c) => { + const id = stringHash(c.fieldName); + aggs[id] = { + stats: { + field: c.fieldName, + }, + }; + return aggs; + }, {} as Record); + + const body = await client.search({ + index: indexPattern, + size: 0, + body: { + query, + aggs: buildSamplerAggregation(minMaxAggs, samplerShardSize), + size: 0, + ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + }, + }); + + const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); + const aggregations = aggsPath.length > 0 ? get(body.aggregations, aggsPath) : body.aggregations; + + return Object.keys(aggregations).reduce((p, aggName) => { + const stats = [aggregations[aggName].min, aggregations[aggName].max]; + if (!stats.includes(null)) { + const delta = aggregations[aggName].max - aggregations[aggName].min; + + let aggInterval = 1; + + if (delta > MAX_CHART_COLUMNS || delta <= 1) { + aggInterval = delta / (MAX_CHART_COLUMNS - 1); + } + + p[aggName] = { interval: aggInterval, min: stats[0], max: stats[1] }; + } + + return p; + }, {} as NumericColumnStatsMap); +}; diff --git a/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.test.ts b/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.test.ts new file mode 100644 index 0000000000000..78b30d27aada0 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.test.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { getSamplerAggregationsResponsePath } from './get_sampler_aggregations_response_path'; + +describe('getSamplerAggregationsResponsePath', () => { + test('returns correct path for sampler shard size of 1000', () => { + expect(getSamplerAggregationsResponsePath(1000)).toEqual(['sample']); + }); + + test('returns correct path for sampler shard size of 0', () => { + expect(getSamplerAggregationsResponsePath(0)).toEqual([]); + }); +}); diff --git a/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.ts b/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.ts new file mode 100644 index 0000000000000..48a9e5051cacd --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.ts @@ -0,0 +1,14 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +// Returns the path of aggregations in the elasticsearch response, as an array, +// depending on whether sampling is being used. +// A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) +// of less than 1 indicates no sampling, and an empty array is returned. +export function getSamplerAggregationsResponsePath(samplerShardSize: number): string[] { + return samplerShardSize > 0 ? ['sample'] : []; +} diff --git a/x-pack/packages/ml/agg_utils/src/index.ts b/x-pack/packages/ml/agg_utils/src/index.ts new file mode 100644 index 0000000000000..6705a28579b40 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/index.ts @@ -0,0 +1,10 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { buildSamplerAggregation } from './build_sampler_aggregation'; +export { getAggIntervals } from './get_agg_intervals'; +export { getSamplerAggregationsResponsePath } from './get_sampler_aggregations_response_path'; diff --git a/x-pack/packages/ml/agg_utils/tsconfig.json b/x-pack/packages/ml/agg_utils/tsconfig.json new file mode 100644 index 0000000000000..b74cfcda5ee73 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node", + ], + }, + "include": [ + "src/**/*", + ] +} diff --git a/x-pack/packages/ml/agg_utils/yarn.lock b/x-pack/packages/ml/agg_utils/yarn.lock new file mode 100644 index 0000000000000..e826cf14c9da2 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/yarn.lock @@ -0,0 +1,300 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@types/command-line-args@^5.0.0": + version "5.2.0" + resolved "https://registry.yarnpkg.com/@types/command-line-args/-/command-line-args-5.2.0.tgz#adbb77980a1cc376bb208e3f4142e907410430f6" + integrity sha512-UuKzKpJJ/Ief6ufIaIzr3A/0XnluX7RvFgwkV89Yzvm77wCh1kFaFmqN8XEnGcN62EuHdedQjEMb8mYxFLGPyA== + +"@types/command-line-usage@^5.0.1": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@types/command-line-usage/-/command-line-usage-5.0.2.tgz#ba5e3f6ae5a2009d466679cc431b50635bf1a064" + integrity sha512-n7RlEEJ+4x4TS7ZQddTmNSxP+zziEG0TNsMfiRIxcIVXt71ENJ9ojeXmGO3wPoTdn7pJcU2xc3CJYMktNT6DPg== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +array-back@^3.0.1, array-back@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-3.1.0.tgz#b8859d7a508871c9a7b2cf42f99428f65e96bfb0" + integrity sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q== + +array-back@^4.0.1, array-back@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-4.0.2.tgz#8004e999a6274586beeb27342168652fdb89fa1e" + integrity sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg== + +braces@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +chalk@^2.4.1, chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + +command-line-application@^0.9.6: + version "0.9.6" + resolved "https://registry.yarnpkg.com/command-line-application/-/command-line-application-0.9.6.tgz#03da3db29a0dbee1af601f03198a2f2425d67803" + integrity sha512-7wc7YX7s/hqZWKp4r37IBlW/Bhh92HWeQW2VV++Mt9x35AKFntz9f7A94Zz+AsImHZmRGHd8iNW5m0jUd4GQpg== + dependencies: + "@types/command-line-args" "^5.0.0" + "@types/command-line-usage" "^5.0.1" + chalk "^2.4.1" + command-line-args "^5.1.1" + command-line-usage "^6.0.0" + meant "^1.0.1" + remove-markdown "^0.3.0" + tslib "1.10.0" + +command-line-args@^5.1.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/command-line-args/-/command-line-args-5.2.1.tgz#c44c32e437a57d7c51157696893c5909e9cec42e" + integrity sha512-H4UfQhZyakIjC74I9d34fGYDwk3XpSr17QhEd0Q3I9Xq1CETHo4Hcuo87WyWHpAF1aSLjLRf5lD9ZGX2qStUvg== + dependencies: + array-back "^3.1.0" + find-replace "^3.0.0" + lodash.camelcase "^4.3.0" + typical "^4.0.0" + +command-line-usage@^6.0.0: + version "6.1.3" + resolved "https://registry.yarnpkg.com/command-line-usage/-/command-line-usage-6.1.3.tgz#428fa5acde6a838779dfa30e44686f4b6761d957" + integrity sha512-sH5ZSPr+7UStsloltmDh7Ce5fb8XPlHyoPzTpyyMuYCtervL65+ubVZ6Q61cFtFl62UyJlc8/JwERRbAFPUqgw== + dependencies: + array-back "^4.0.2" + chalk "^2.4.2" + table-layout "^1.0.2" + typical "^5.2.0" + +deep-extend@~0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +fast-glob@^3.1.1: + version "3.2.11" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" + integrity sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-replace@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/find-replace/-/find-replace-3.0.0.tgz#3e7e23d3b05167a76f770c9fbd5258b0def68c38" + integrity sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ== + dependencies: + array-back "^3.0.1" + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-glob@^4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +lodash.camelcase@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz#b28aa6288a2b9fc651035c7711f65ab6190331a6" + integrity sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA== + +meant@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/meant/-/meant-1.0.3.tgz#67769af9de1d158773e928ae82c456114903554c" + integrity sha512-88ZRGcNxAq4EH38cQ4D85PM57pikCwS8Z99EWHODxN7KBY+UuPiqzRTtZzS8KTXO/ywSWbdjjJST2Hly/EQxLw== + +merge2@^1.3.0: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.5" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" + integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== + dependencies: + braces "^3.0.2" + picomatch "^2.3.1" + +picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +prettier@1.19.1: + version "1.19.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.19.1.tgz#f7d7f5ff8a9cd872a7be4ca142095956a60797cb" + integrity sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew== + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +reduce-flatten@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/reduce-flatten/-/reduce-flatten-2.0.0.tgz#734fd84e65f375d7ca4465c69798c25c9d10ae27" + integrity sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w== + +remove-markdown@^0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/remove-markdown/-/remove-markdown-0.3.0.tgz#5e4b667493a93579728f3d52ecc1db9ca505dc98" + integrity sha512-5392eIuy1mhjM74739VunOlsOYKjsH82rQcTBlJ1bkICVC3dQ3ksQzTHh4jGHQFnM+1xzLzcFOMH+BofqXhroQ== + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +table-layout@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/table-layout/-/table-layout-1.0.2.tgz#c4038a1853b0136d63365a734b6931cf4fad4a04" + integrity sha512-qd/R7n5rQTRFi+Zf2sk5XVVd9UQl6ZkduPFC3S7WEGJAmetDTjY3qPN50eSKzwuzEyQKy5TN2TiZdkIjos2L6A== + dependencies: + array-back "^4.0.1" + deep-extend "~0.6.0" + typical "^5.2.0" + wordwrapjs "^4.0.0" + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +ts-readme@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/ts-readme/-/ts-readme-1.1.3.tgz#18a73d21f3bb50ee8e2df819bcbbe3a76385b15a" + integrity sha512-GvI+Vu3m/LGBlgrWwzSmvslnz8msJLNrZ7hQ3Ko2B6PMxeXidqsn6fi20IWgepFjOzhKGw/WlG8NmM7jl3DWeg== + dependencies: + command-line-application "^0.9.6" + fast-glob "^3.1.1" + prettier "1.19.1" + +tslib@1.10.0: + version "1.10.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.10.0.tgz#c3c19f95973fb0a62973fb09d90d961ee43e5c8a" + integrity sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ== + +typical@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-4.0.0.tgz#cbeaff3b9d7ae1e2bbfaf5a4e6f11eccfde94fc4" + integrity sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw== + +typical@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-5.2.0.tgz#4daaac4f2b5315460804f0acf6cb69c52bb93066" + integrity sha512-dvdQgNDNJo+8B2uBQoqdb11eUCE1JQXhvjC/CZtgvZseVd5TYMXnq0+vuUemXbd/Se29cTaUuPX3YIc2xgbvIg== + +wordwrapjs@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/wordwrapjs/-/wordwrapjs-4.0.1.tgz#d9790bccfb110a0fc7836b5ebce0937b37a8b98f" + integrity sha512-kKlNACbvHrkpIw6oPeYDSmdCTu2hdMHoyXLTcUKala++lx5Y+wjJ/e474Jqv5abnVmwxw08DiTuHmw69lJGksA== + dependencies: + reduce-flatten "^2.0.0" + typical "^5.2.0" diff --git a/x-pack/packages/ml/is_populated_object/BUILD.bazel b/x-pack/packages/ml/is_populated_object/BUILD.bazel new file mode 100644 index 0000000000000..e89b39af7c986 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/BUILD.bazel @@ -0,0 +1,114 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "is_populated_object" +PKG_REQUIRE_NAME = "@kbn/ml-is-populated-object" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/x-pack/packages/ml/is_populated_object/README.md b/x-pack/packages/ml/is_populated_object/README.md new file mode 100644 index 0000000000000..8d2d47329a3fa --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/README.md @@ -0,0 +1,24 @@ +# @kbn/ml-is-populated-object + + + +### `isPopulatedObject` (function) + +A type guard to check record like object structures. + +Examples: + +- `isPopulatedObject({...})` + Limits type to Record + +- `isPopulatedObject({...}, ['attribute'])` + Limits type to Record<'attribute', unknown> + +- `isPopulatedObject({...})` + Limits type to a record with keys of the given interface. + Note that you might want to add keys from the interface to the + array of requiredAttributes to satisfy runtime requirements. + Otherwise you'd just satisfy TS requirements but might still + run into runtime issues. + + diff --git a/x-pack/packages/ml/is_populated_object/jest.config.js b/x-pack/packages/ml/is_populated_object/jest.config.js new file mode 100644 index 0000000000000..8ce420d82a0a4 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/jest.config.js @@ -0,0 +1,12 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/x-pack/packages/ml/is_populated_object'], +}; diff --git a/x-pack/packages/ml/is_populated_object/package.json b/x-pack/packages/ml/is_populated_object/package.json new file mode 100644 index 0000000000000..3ca3e0fcffb01 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/package.json @@ -0,0 +1,13 @@ +{ + "name": "@kbn/ml-is-populated-object", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "devDependencies": { + "ts-readme": "^1.1.3" + }, + "scripts": { + "generate-docs": "ts-readme src/index.ts" + } +} diff --git a/x-pack/packages/ml/is_populated_object/src/index.ts b/x-pack/packages/ml/is_populated_object/src/index.ts new file mode 100644 index 0000000000000..b2b1532739628 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/src/index.ts @@ -0,0 +1,8 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { isPopulatedObject } from './is_populated_object'; diff --git a/x-pack/packages/ml/is_populated_object/src/is_populated_object.test.ts b/x-pack/packages/ml/is_populated_object/src/is_populated_object.test.ts new file mode 100644 index 0000000000000..c606c0677cf67 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/src/is_populated_object.test.ts @@ -0,0 +1,48 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { isPopulatedObject } from './is_populated_object'; + +describe('isPopulatedObject', () => { + it('does not allow numbers', () => { + expect(isPopulatedObject(0)).toBe(false); + }); + it('does not allow strings', () => { + expect(isPopulatedObject('')).toBe(false); + }); + it('does not allow null', () => { + expect(isPopulatedObject(null)).toBe(false); + }); + it('does not allow an empty object', () => { + expect(isPopulatedObject({})).toBe(false); + }); + it('allows an object with an attribute', () => { + expect(isPopulatedObject({ attribute: 'value' })).toBe(true); + }); + it('does not allow an object with a non-existing required attribute', () => { + expect(isPopulatedObject({ attribute: 'value' }, ['otherAttribute'])).toBe(false); + }); + it('allows an object with an existing required attribute', () => { + expect(isPopulatedObject({ attribute: 'value' }, ['attribute'])).toBe(true); + }); + it('allows an object with two existing required attributes', () => { + expect( + isPopulatedObject({ attribute1: 'value1', attribute2: 'value2' }, [ + 'attribute1', + 'attribute2', + ]) + ).toBe(true); + }); + it('does not allow an object with two required attributes where one does not exist', () => { + expect( + isPopulatedObject({ attribute1: 'value1', attribute2: 'value2' }, [ + 'attribute1', + 'otherAttribute', + ]) + ).toBe(false); + }); +}); diff --git a/x-pack/packages/ml/is_populated_object/src/is_populated_object.ts b/x-pack/packages/ml/is_populated_object/src/is_populated_object.ts new file mode 100644 index 0000000000000..43c529206bb63 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/src/is_populated_object.ts @@ -0,0 +1,36 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/** + * A type guard to check record like object structures. + * + * Examples: + * - `isPopulatedObject({...})` + * Limits type to Record + * + * - `isPopulatedObject({...}, ['attribute'])` + * Limits type to Record<'attribute', unknown> + * + * - `isPopulatedObject({...})` + * Limits type to a record with keys of the given interface. + * Note that you might want to add keys from the interface to the + * array of requiredAttributes to satisfy runtime requirements. + * Otherwise you'd just satisfy TS requirements but might still + * run into runtime issues. + */ +export const isPopulatedObject = ( + arg: unknown, + requiredAttributes: U[] = [] +): arg is Record => { + return ( + typeof arg === 'object' && + arg !== null && + Object.keys(arg).length > 0 && + (requiredAttributes.length === 0 || + requiredAttributes.every((d) => ({}.hasOwnProperty.call(arg, d)))) + ); +}; diff --git a/x-pack/packages/ml/is_populated_object/tsconfig.json b/x-pack/packages/ml/is_populated_object/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/x-pack/packages/ml/is_populated_object/yarn.lock b/x-pack/packages/ml/is_populated_object/yarn.lock new file mode 100644 index 0000000000000..e826cf14c9da2 --- /dev/null +++ b/x-pack/packages/ml/is_populated_object/yarn.lock @@ -0,0 +1,300 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@types/command-line-args@^5.0.0": + version "5.2.0" + resolved "https://registry.yarnpkg.com/@types/command-line-args/-/command-line-args-5.2.0.tgz#adbb77980a1cc376bb208e3f4142e907410430f6" + integrity sha512-UuKzKpJJ/Ief6ufIaIzr3A/0XnluX7RvFgwkV89Yzvm77wCh1kFaFmqN8XEnGcN62EuHdedQjEMb8mYxFLGPyA== + +"@types/command-line-usage@^5.0.1": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@types/command-line-usage/-/command-line-usage-5.0.2.tgz#ba5e3f6ae5a2009d466679cc431b50635bf1a064" + integrity sha512-n7RlEEJ+4x4TS7ZQddTmNSxP+zziEG0TNsMfiRIxcIVXt71ENJ9ojeXmGO3wPoTdn7pJcU2xc3CJYMktNT6DPg== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +array-back@^3.0.1, array-back@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-3.1.0.tgz#b8859d7a508871c9a7b2cf42f99428f65e96bfb0" + integrity sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q== + +array-back@^4.0.1, array-back@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-4.0.2.tgz#8004e999a6274586beeb27342168652fdb89fa1e" + integrity sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg== + +braces@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +chalk@^2.4.1, chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + +command-line-application@^0.9.6: + version "0.9.6" + resolved "https://registry.yarnpkg.com/command-line-application/-/command-line-application-0.9.6.tgz#03da3db29a0dbee1af601f03198a2f2425d67803" + integrity sha512-7wc7YX7s/hqZWKp4r37IBlW/Bhh92HWeQW2VV++Mt9x35AKFntz9f7A94Zz+AsImHZmRGHd8iNW5m0jUd4GQpg== + dependencies: + "@types/command-line-args" "^5.0.0" + "@types/command-line-usage" "^5.0.1" + chalk "^2.4.1" + command-line-args "^5.1.1" + command-line-usage "^6.0.0" + meant "^1.0.1" + remove-markdown "^0.3.0" + tslib "1.10.0" + +command-line-args@^5.1.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/command-line-args/-/command-line-args-5.2.1.tgz#c44c32e437a57d7c51157696893c5909e9cec42e" + integrity sha512-H4UfQhZyakIjC74I9d34fGYDwk3XpSr17QhEd0Q3I9Xq1CETHo4Hcuo87WyWHpAF1aSLjLRf5lD9ZGX2qStUvg== + dependencies: + array-back "^3.1.0" + find-replace "^3.0.0" + lodash.camelcase "^4.3.0" + typical "^4.0.0" + +command-line-usage@^6.0.0: + version "6.1.3" + resolved "https://registry.yarnpkg.com/command-line-usage/-/command-line-usage-6.1.3.tgz#428fa5acde6a838779dfa30e44686f4b6761d957" + integrity sha512-sH5ZSPr+7UStsloltmDh7Ce5fb8XPlHyoPzTpyyMuYCtervL65+ubVZ6Q61cFtFl62UyJlc8/JwERRbAFPUqgw== + dependencies: + array-back "^4.0.2" + chalk "^2.4.2" + table-layout "^1.0.2" + typical "^5.2.0" + +deep-extend@~0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +fast-glob@^3.1.1: + version "3.2.11" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" + integrity sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-replace@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/find-replace/-/find-replace-3.0.0.tgz#3e7e23d3b05167a76f770c9fbd5258b0def68c38" + integrity sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ== + dependencies: + array-back "^3.0.1" + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-glob@^4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +lodash.camelcase@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz#b28aa6288a2b9fc651035c7711f65ab6190331a6" + integrity sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA== + +meant@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/meant/-/meant-1.0.3.tgz#67769af9de1d158773e928ae82c456114903554c" + integrity sha512-88ZRGcNxAq4EH38cQ4D85PM57pikCwS8Z99EWHODxN7KBY+UuPiqzRTtZzS8KTXO/ywSWbdjjJST2Hly/EQxLw== + +merge2@^1.3.0: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.5" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" + integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== + dependencies: + braces "^3.0.2" + picomatch "^2.3.1" + +picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +prettier@1.19.1: + version "1.19.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.19.1.tgz#f7d7f5ff8a9cd872a7be4ca142095956a60797cb" + integrity sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew== + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +reduce-flatten@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/reduce-flatten/-/reduce-flatten-2.0.0.tgz#734fd84e65f375d7ca4465c69798c25c9d10ae27" + integrity sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w== + +remove-markdown@^0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/remove-markdown/-/remove-markdown-0.3.0.tgz#5e4b667493a93579728f3d52ecc1db9ca505dc98" + integrity sha512-5392eIuy1mhjM74739VunOlsOYKjsH82rQcTBlJ1bkICVC3dQ3ksQzTHh4jGHQFnM+1xzLzcFOMH+BofqXhroQ== + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +table-layout@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/table-layout/-/table-layout-1.0.2.tgz#c4038a1853b0136d63365a734b6931cf4fad4a04" + integrity sha512-qd/R7n5rQTRFi+Zf2sk5XVVd9UQl6ZkduPFC3S7WEGJAmetDTjY3qPN50eSKzwuzEyQKy5TN2TiZdkIjos2L6A== + dependencies: + array-back "^4.0.1" + deep-extend "~0.6.0" + typical "^5.2.0" + wordwrapjs "^4.0.0" + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +ts-readme@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/ts-readme/-/ts-readme-1.1.3.tgz#18a73d21f3bb50ee8e2df819bcbbe3a76385b15a" + integrity sha512-GvI+Vu3m/LGBlgrWwzSmvslnz8msJLNrZ7hQ3Ko2B6PMxeXidqsn6fi20IWgepFjOzhKGw/WlG8NmM7jl3DWeg== + dependencies: + command-line-application "^0.9.6" + fast-glob "^3.1.1" + prettier "1.19.1" + +tslib@1.10.0: + version "1.10.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.10.0.tgz#c3c19f95973fb0a62973fb09d90d961ee43e5c8a" + integrity sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ== + +typical@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-4.0.0.tgz#cbeaff3b9d7ae1e2bbfaf5a4e6f11eccfde94fc4" + integrity sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw== + +typical@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-5.2.0.tgz#4daaac4f2b5315460804f0acf6cb69c52bb93066" + integrity sha512-dvdQgNDNJo+8B2uBQoqdb11eUCE1JQXhvjC/CZtgvZseVd5TYMXnq0+vuUemXbd/Se29cTaUuPX3YIc2xgbvIg== + +wordwrapjs@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/wordwrapjs/-/wordwrapjs-4.0.1.tgz#d9790bccfb110a0fc7836b5ebce0937b37a8b98f" + integrity sha512-kKlNACbvHrkpIw6oPeYDSmdCTu2hdMHoyXLTcUKala++lx5Y+wjJ/e474Jqv5abnVmwxw08DiTuHmw69lJGksA== + dependencies: + reduce-flatten "^2.0.0" + typical "^5.2.0" diff --git a/x-pack/packages/ml/string_hash/BUILD.bazel b/x-pack/packages/ml/string_hash/BUILD.bazel new file mode 100644 index 0000000000000..50e89a8975b51 --- /dev/null +++ b/x-pack/packages/ml/string_hash/BUILD.bazel @@ -0,0 +1,114 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "string_hash" +PKG_REQUIRE_NAME = "@kbn/ml-string-hash" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/x-pack/packages/ml/string_hash/README.md b/x-pack/packages/ml/string_hash/README.md new file mode 100644 index 0000000000000..32ea547e20f37 --- /dev/null +++ b/x-pack/packages/ml/string_hash/README.md @@ -0,0 +1,15 @@ +# @kbn/ml-string-hash + + + +### `stringHash` (function) + +Creates a deterministic number based hash out of a string. + +**Parameters:** + +- str (`string`) + +**returns:** number + + diff --git a/x-pack/packages/ml/string_hash/jest.config.js b/x-pack/packages/ml/string_hash/jest.config.js new file mode 100644 index 0000000000000..4f9fe0d1c70e0 --- /dev/null +++ b/x-pack/packages/ml/string_hash/jest.config.js @@ -0,0 +1,12 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/x-pack/packages/ml/string_hash'], +}; diff --git a/x-pack/packages/ml/string_hash/package.json b/x-pack/packages/ml/string_hash/package.json new file mode 100644 index 0000000000000..81a0bf1c743f5 --- /dev/null +++ b/x-pack/packages/ml/string_hash/package.json @@ -0,0 +1,13 @@ +{ + "name": "@kbn/ml-string-hash", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "devDependencies": { + "ts-readme": "^1.1.3" + }, + "scripts": { + "generate-docs": "ts-readme src/index.ts" + } +} diff --git a/x-pack/packages/ml/string_hash/src/index.ts b/x-pack/packages/ml/string_hash/src/index.ts new file mode 100644 index 0000000000000..f833c95914fb2 --- /dev/null +++ b/x-pack/packages/ml/string_hash/src/index.ts @@ -0,0 +1,8 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { stringHash } from './string_hash'; diff --git a/x-pack/packages/ml/string_hash/src/string_hash.test.ts b/x-pack/packages/ml/string_hash/src/string_hash.test.ts new file mode 100644 index 0000000000000..3354e36455790 --- /dev/null +++ b/x-pack/packages/ml/string_hash/src/string_hash.test.ts @@ -0,0 +1,16 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { stringHash } from './string_hash'; + +describe('stringHash', () => { + test('should return a unique number based off a string', () => { + const hash1 = stringHash('the-string-1'); + const hash2 = stringHash('the-string-2'); + expect(hash1).not.toBe(hash2); + }); +}); diff --git a/x-pack/plugins/data_visualizer/common/utils/string_utils.ts b/x-pack/packages/ml/string_hash/src/string_hash.ts similarity index 100% rename from x-pack/plugins/data_visualizer/common/utils/string_utils.ts rename to x-pack/packages/ml/string_hash/src/string_hash.ts diff --git a/x-pack/packages/ml/string_hash/tsconfig.json b/x-pack/packages/ml/string_hash/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/x-pack/packages/ml/string_hash/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/x-pack/packages/ml/string_hash/yarn.lock b/x-pack/packages/ml/string_hash/yarn.lock new file mode 100644 index 0000000000000..e826cf14c9da2 --- /dev/null +++ b/x-pack/packages/ml/string_hash/yarn.lock @@ -0,0 +1,300 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@types/command-line-args@^5.0.0": + version "5.2.0" + resolved "https://registry.yarnpkg.com/@types/command-line-args/-/command-line-args-5.2.0.tgz#adbb77980a1cc376bb208e3f4142e907410430f6" + integrity sha512-UuKzKpJJ/Ief6ufIaIzr3A/0XnluX7RvFgwkV89Yzvm77wCh1kFaFmqN8XEnGcN62EuHdedQjEMb8mYxFLGPyA== + +"@types/command-line-usage@^5.0.1": + version "5.0.2" + resolved "https://registry.yarnpkg.com/@types/command-line-usage/-/command-line-usage-5.0.2.tgz#ba5e3f6ae5a2009d466679cc431b50635bf1a064" + integrity sha512-n7RlEEJ+4x4TS7ZQddTmNSxP+zziEG0TNsMfiRIxcIVXt71ENJ9ojeXmGO3wPoTdn7pJcU2xc3CJYMktNT6DPg== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +array-back@^3.0.1, array-back@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-3.1.0.tgz#b8859d7a508871c9a7b2cf42f99428f65e96bfb0" + integrity sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q== + +array-back@^4.0.1, array-back@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-4.0.2.tgz#8004e999a6274586beeb27342168652fdb89fa1e" + integrity sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg== + +braces@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +chalk@^2.4.1, chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== + +command-line-application@^0.9.6: + version "0.9.6" + resolved "https://registry.yarnpkg.com/command-line-application/-/command-line-application-0.9.6.tgz#03da3db29a0dbee1af601f03198a2f2425d67803" + integrity sha512-7wc7YX7s/hqZWKp4r37IBlW/Bhh92HWeQW2VV++Mt9x35AKFntz9f7A94Zz+AsImHZmRGHd8iNW5m0jUd4GQpg== + dependencies: + "@types/command-line-args" "^5.0.0" + "@types/command-line-usage" "^5.0.1" + chalk "^2.4.1" + command-line-args "^5.1.1" + command-line-usage "^6.0.0" + meant "^1.0.1" + remove-markdown "^0.3.0" + tslib "1.10.0" + +command-line-args@^5.1.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/command-line-args/-/command-line-args-5.2.1.tgz#c44c32e437a57d7c51157696893c5909e9cec42e" + integrity sha512-H4UfQhZyakIjC74I9d34fGYDwk3XpSr17QhEd0Q3I9Xq1CETHo4Hcuo87WyWHpAF1aSLjLRf5lD9ZGX2qStUvg== + dependencies: + array-back "^3.1.0" + find-replace "^3.0.0" + lodash.camelcase "^4.3.0" + typical "^4.0.0" + +command-line-usage@^6.0.0: + version "6.1.3" + resolved "https://registry.yarnpkg.com/command-line-usage/-/command-line-usage-6.1.3.tgz#428fa5acde6a838779dfa30e44686f4b6761d957" + integrity sha512-sH5ZSPr+7UStsloltmDh7Ce5fb8XPlHyoPzTpyyMuYCtervL65+ubVZ6Q61cFtFl62UyJlc8/JwERRbAFPUqgw== + dependencies: + array-back "^4.0.2" + chalk "^2.4.2" + table-layout "^1.0.2" + typical "^5.2.0" + +deep-extend@~0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== + +fast-glob@^3.1.1: + version "3.2.11" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" + integrity sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-replace@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/find-replace/-/find-replace-3.0.0.tgz#3e7e23d3b05167a76f770c9fbd5258b0def68c38" + integrity sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ== + dependencies: + array-back "^3.0.1" + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-glob@^4.0.1: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +lodash.camelcase@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz#b28aa6288a2b9fc651035c7711f65ab6190331a6" + integrity sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA== + +meant@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/meant/-/meant-1.0.3.tgz#67769af9de1d158773e928ae82c456114903554c" + integrity sha512-88ZRGcNxAq4EH38cQ4D85PM57pikCwS8Z99EWHODxN7KBY+UuPiqzRTtZzS8KTXO/ywSWbdjjJST2Hly/EQxLw== + +merge2@^1.3.0: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.5" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" + integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== + dependencies: + braces "^3.0.2" + picomatch "^2.3.1" + +picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +prettier@1.19.1: + version "1.19.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.19.1.tgz#f7d7f5ff8a9cd872a7be4ca142095956a60797cb" + integrity sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew== + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +reduce-flatten@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/reduce-flatten/-/reduce-flatten-2.0.0.tgz#734fd84e65f375d7ca4465c69798c25c9d10ae27" + integrity sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w== + +remove-markdown@^0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/remove-markdown/-/remove-markdown-0.3.0.tgz#5e4b667493a93579728f3d52ecc1db9ca505dc98" + integrity sha512-5392eIuy1mhjM74739VunOlsOYKjsH82rQcTBlJ1bkICVC3dQ3ksQzTHh4jGHQFnM+1xzLzcFOMH+BofqXhroQ== + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +table-layout@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/table-layout/-/table-layout-1.0.2.tgz#c4038a1853b0136d63365a734b6931cf4fad4a04" + integrity sha512-qd/R7n5rQTRFi+Zf2sk5XVVd9UQl6ZkduPFC3S7WEGJAmetDTjY3qPN50eSKzwuzEyQKy5TN2TiZdkIjos2L6A== + dependencies: + array-back "^4.0.1" + deep-extend "~0.6.0" + typical "^5.2.0" + wordwrapjs "^4.0.0" + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +ts-readme@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/ts-readme/-/ts-readme-1.1.3.tgz#18a73d21f3bb50ee8e2df819bcbbe3a76385b15a" + integrity sha512-GvI+Vu3m/LGBlgrWwzSmvslnz8msJLNrZ7hQ3Ko2B6PMxeXidqsn6fi20IWgepFjOzhKGw/WlG8NmM7jl3DWeg== + dependencies: + command-line-application "^0.9.6" + fast-glob "^3.1.1" + prettier "1.19.1" + +tslib@1.10.0: + version "1.10.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.10.0.tgz#c3c19f95973fb0a62973fb09d90d961ee43e5c8a" + integrity sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ== + +typical@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-4.0.0.tgz#cbeaff3b9d7ae1e2bbfaf5a4e6f11eccfde94fc4" + integrity sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw== + +typical@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-5.2.0.tgz#4daaac4f2b5315460804f0acf6cb69c52bb93066" + integrity sha512-dvdQgNDNJo+8B2uBQoqdb11eUCE1JQXhvjC/CZtgvZseVd5TYMXnq0+vuUemXbd/Se29cTaUuPX3YIc2xgbvIg== + +wordwrapjs@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/wordwrapjs/-/wordwrapjs-4.0.1.tgz#d9790bccfb110a0fc7836b5ebce0937b37a8b98f" + integrity sha512-kKlNACbvHrkpIw6oPeYDSmdCTu2hdMHoyXLTcUKala++lx5Y+wjJ/e474Jqv5abnVmwxw08DiTuHmw69lJGksA== + dependencies: + reduce-flatten "^2.0.0" + typical "^5.2.0" diff --git a/x-pack/plugins/apm/dev_docs/local_setup.md b/x-pack/plugins/apm/dev_docs/local_setup.md index 42aaf686dac5b..24a8db44a3cce 100644 --- a/x-pack/plugins/apm/dev_docs/local_setup.md +++ b/x-pack/plugins/apm/dev_docs/local_setup.md @@ -90,8 +90,8 @@ node x-pack/plugins/apm/scripts/create_apm_users.js --username admin --password This will create: -- **viewer_user**: User with `viewer` role (read-only) -- **editor_user**: User with `editor` role (read/write) +- **viewer**: User with `viewer` role (read-only) +- **editor**: User with `editor` role (read/write) # Debugging Elasticsearch queries diff --git a/x-pack/plugins/apm/ftr_e2e/cypress/integration/power_user/no_data_screen.ts b/x-pack/plugins/apm/ftr_e2e/cypress/integration/power_user/no_data_screen.ts index 65591bf991ab8..c7f33301a5dfc 100644 --- a/x-pack/plugins/apm/ftr_e2e/cypress/integration/power_user/no_data_screen.ts +++ b/x-pack/plugins/apm/ftr_e2e/cypress/integration/power_user/no_data_screen.ts @@ -29,7 +29,7 @@ describe('No data screen', () => { headers: { 'kbn-xsrf': true, }, - auth: { user: 'editor_user', pass: 'changeme' }, + auth: { user: 'editor', pass: 'changeme' }, }); }); @@ -57,7 +57,7 @@ describe('No data screen', () => { metric: '', }, headers: { 'kbn-xsrf': true }, - auth: { user: 'editor_user', pass: 'changeme' }, + auth: { user: 'editor', pass: 'changeme' }, }); }); }); diff --git a/x-pack/plugins/apm/ftr_e2e/cypress/support/commands.ts b/x-pack/plugins/apm/ftr_e2e/cypress/support/commands.ts index bf0be24353847..94c1f44cbcffc 100644 --- a/x-pack/plugins/apm/ftr_e2e/cypress/support/commands.ts +++ b/x-pack/plugins/apm/ftr_e2e/cypress/support/commands.ts @@ -11,11 +11,11 @@ import moment from 'moment'; import { AXE_CONFIG, AXE_OPTIONS } from '@kbn/axe-config'; Cypress.Commands.add('loginAsViewerUser', () => { - cy.loginAs({ username: 'viewer_user', password: 'changeme' }); + cy.loginAs({ username: 'viewer', password: 'changeme' }); }); Cypress.Commands.add('loginAsEditorUser', () => { - cy.loginAs({ username: 'editor_user', password: 'changeme' }); + cy.loginAs({ username: 'editor', password: 'changeme' }); }); Cypress.Commands.add( diff --git a/x-pack/plugins/apm/public/components/alerting/transaction_duration_anomaly_alert_trigger/select_anomaly_severity.tsx b/x-pack/plugins/apm/public/components/alerting/transaction_duration_anomaly_alert_trigger/select_anomaly_severity.tsx index 70d4702a326ef..f8d414ff326cc 100644 --- a/x-pack/plugins/apm/public/components/alerting/transaction_duration_anomaly_alert_trigger/select_anomaly_severity.tsx +++ b/x-pack/plugins/apm/public/components/alerting/transaction_duration_anomaly_alert_trigger/select_anomaly_severity.tsx @@ -46,10 +46,7 @@ export function SelectAnomalySeverity({ onChange, value }: Props) { -

+

} diff --git a/x-pack/plugins/apm/public/components/app/correlations/failed_transactions_correlations.tsx b/x-pack/plugins/apm/public/components/app/correlations/failed_transactions_correlations.tsx index c689c06ec45a4..a330b08c0ad6f 100644 --- a/x-pack/plugins/apm/public/components/app/correlations/failed_transactions_correlations.tsx +++ b/x-pack/plugins/apm/public/components/app/correlations/failed_transactions_correlations.tsx @@ -513,7 +513,7 @@ export function FailedTransactionsCorrelations({ style={{ display: 'flex', flexDirection: 'row', - paddingLeft: euiTheme.eui.paddingSizes.s, + paddingLeft: euiTheme.eui.euiSizeS, }} > theme.eui.paddingSizes.xs}; + margin: ${({ theme }) => theme.eui.euiSizeXS}; `; const ZoomInButton = euiStyled(Button)` - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; `; const Panel = euiStyled(EuiPanel)` - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; `; const steps = 5; diff --git a/x-pack/plugins/apm/public/components/app/service_map/cytoscape_options.ts b/x-pack/plugins/apm/public/components/app/service_map/cytoscape_options.ts index 2c9a471b6621e..524006967cbf5 100644 --- a/x-pack/plugins/apm/public/components/app/service_map/cytoscape_options.ts +++ b/x-pack/plugins/apm/public/components/app/service_map/cytoscape_options.ts @@ -153,9 +153,9 @@ const getStyle = ( 'text-background-color': theme.eui.euiColorPrimary, 'text-background-opacity': (el: cytoscape.NodeSingular) => el.hasClass('primary') || el.selected() ? 0.1 : 0, - 'text-background-padding': theme.eui.paddingSizes.xs, + 'text-background-padding': theme.eui.euiSizeXS, 'text-background-shape': 'roundrectangle', - 'text-margin-y': parseInt(theme.eui.paddingSizes.s, 10), + 'text-margin-y': parseInt(theme.eui.euiSizeS, 10), 'text-max-width': '200px', 'text-valign': 'bottom', 'text-wrap': 'ellipsis', @@ -175,9 +175,7 @@ const getStyle = ( // fairly new. // // @ts-expect-error - 'target-distance-from-node': isIE11 - ? undefined - : theme.eui.paddingSizes.xs, + 'target-distance-from-node': isIE11 ? undefined : theme.eui.euiSizeXS, width: 1, 'source-arrow-shape': 'none', 'z-index': zIndexEdge, @@ -192,10 +190,10 @@ const getStyle = ( // @ts-expect-error 'source-distance-from-node': isIE11 ? undefined - : parseInt(theme.eui.paddingSizes.xs, 10), + : parseInt(theme.eui.euiSizeXS, 10), 'target-distance-from-node': isIE11 ? undefined - : parseInt(theme.eui.paddingSizes.xs, 10), + : parseInt(theme.eui.euiSizeXS, 10), }, }, { diff --git a/x-pack/plugins/apm/public/components/app/service_profiling/service_profiling_flamegraph.tsx b/x-pack/plugins/apm/public/components/app/service_profiling/service_profiling_flamegraph.tsx index 1c92d6831e87f..064b33d2dd9c0 100644 --- a/x-pack/plugins/apm/public/components/app/service_profiling/service_profiling_flamegraph.tsx +++ b/x-pack/plugins/apm/public/components/app/service_profiling/service_profiling_flamegraph.tsx @@ -60,7 +60,7 @@ const TooltipContainer = euiStyled.div` background-color: ${(props) => props.theme.eui.euiColorDarkestShade}; border-radius: ${(props) => props.theme.eui.euiBorderRadius}; color: ${(props) => props.theme.eui.euiColorLightestShade}; - padding: ${(props) => props.theme.eui.paddingSizes.s}; + padding: ${(props) => props.theme.eui.euiSizeS}; `; const formatValue = ( diff --git a/x-pack/plugins/apm/public/components/app/settings/custom_link/create_edit_custom_link_flyout/link_preview.test.tsx b/x-pack/plugins/apm/public/components/app/settings/custom_link/create_edit_custom_link_flyout/link_preview.test.tsx index 4c8a5bc00285e..00145dff25754 100644 --- a/x-pack/plugins/apm/public/components/app/settings/custom_link/create_edit_custom_link_flyout/link_preview.test.tsx +++ b/x-pack/plugins/apm/public/components/app/settings/custom_link/create_edit_custom_link_flyout/link_preview.test.tsx @@ -23,12 +23,7 @@ export const removeExternalLinkText = (str: string) => describe('LinkPreview', () => { const getElementValue = (container: HTMLElement, id: string) => - getNodeText( - ( - (getByTestId(container, id) as HTMLDivElement) - .children as HTMLCollection - )[0] as HTMLDivElement - ); + getNodeText(getByTestId(container, id)); it('shows label and url default values', () => { act(() => { diff --git a/x-pack/plugins/apm/public/components/app/transaction_details/waterfall_with_summary/waterfall_container/waterfall/waterfall_item.tsx b/x-pack/plugins/apm/public/components/app/transaction_details/waterfall_with_summary/waterfall_container/waterfall/waterfall_item.tsx index 1b16840e566cd..329141612dcec 100644 --- a/x-pack/plugins/apm/public/components/app/transaction_details/waterfall_with_summary/waterfall_container/waterfall/waterfall_item.tsx +++ b/x-pack/plugins/apm/public/components/app/transaction_details/waterfall_with_summary/waterfall_container/waterfall/waterfall_item.tsx @@ -44,7 +44,7 @@ const Container = euiStyled.div` position: relative; display: block; user-select: none; - padding-top: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-top: ${({ theme }) => theme.eui.euiSizeS}; padding-bottom: ${({ theme }) => theme.eui.euiSizeM}; margin-right: ${(props) => props.timelineMargins.right}px; margin-left: ${(props) => diff --git a/x-pack/plugins/apm/public/components/shared/charts/instances_latency_distribution_chart/custom_tooltip.tsx b/x-pack/plugins/apm/public/components/shared/charts/instances_latency_distribution_chart/custom_tooltip.tsx index 39451002efcb2..63e8ff6bdd850 100644 --- a/x-pack/plugins/apm/public/components/shared/charts/instances_latency_distribution_chart/custom_tooltip.tsx +++ b/x-pack/plugins/apm/public/components/shared/charts/instances_latency_distribution_chart/custom_tooltip.tsx @@ -156,7 +156,7 @@ function MultipleInstanceCustomTooltip({

{latencyLabel} @@ -176,7 +176,7 @@ function MultipleInstanceCustomTooltip({
{throughputLabel} @@ -211,7 +211,7 @@ export function CustomTooltip( ) : ( )} -
+
{clickToFilterDescription}
diff --git a/x-pack/plugins/apm/public/components/shared/charts/timeline/marker/agent_marker.tsx b/x-pack/plugins/apm/public/components/shared/charts/timeline/marker/agent_marker.tsx index 46c04983464e8..37ddfbda58c3b 100644 --- a/x-pack/plugins/apm/public/components/shared/charts/timeline/marker/agent_marker.tsx +++ b/x-pack/plugins/apm/public/components/shared/charts/timeline/marker/agent_marker.tsx @@ -15,12 +15,12 @@ import { Legend } from '../legend'; const NameContainer = euiStyled.div` border-bottom: 1px solid ${({ theme }) => theme.eui.euiColorMediumShade}; - padding-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-bottom: ${({ theme }) => theme.eui.euiSizeS}; `; const TimeContainer = euiStyled.div` color: ${({ theme }) => theme.eui.euiColorMediumShade}; - padding-top: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-top: ${({ theme }) => theme.eui.euiSizeS}; `; interface Props { diff --git a/x-pack/plugins/apm/public/components/shared/kuery_bar/typeahead/suggestion.js b/x-pack/plugins/apm/public/components/shared/kuery_bar/typeahead/suggestion.js index 9c2ee835b8f72..3a300cea12173 100644 --- a/x-pack/plugins/apm/public/components/shared/kuery_bar/typeahead/suggestion.js +++ b/x-pack/plugins/apm/public/components/shared/kuery_bar/typeahead/suggestion.js @@ -36,7 +36,7 @@ const Description = euiStyled.div` span { font-family: ${({ theme }) => theme.eui.euiCodeFontFamily}; color: ${({ theme }) => theme.eui.euiColorFullShade}; - padding: 0 ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: 0 ${({ theme }) => theme.eui.euiSizeXS}; display: inline-block; } } @@ -75,7 +75,7 @@ const Icon = euiStyled.div` const TextValue = euiStyled.div` flex: 0 0 ${unit * 16}px; color: ${({ theme }) => theme.eui.euiColorDarkestShade}; - padding: 0 ${({ theme }) => theme.eui.paddingSizes.s}; + padding: 0 ${({ theme }) => theme.eui.euiSizeS}; `; function getEuiIconType(type) { diff --git a/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.test.tsx b/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.test.tsx index 5b8cf6e4ad496..07d5c29eb34c6 100644 --- a/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.test.tsx +++ b/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.test.tsx @@ -46,7 +46,9 @@ describe('CauseStacktrace', () => { }; expect( - shallow().find('Styled(EuiAccordion)') + shallow().find( + 'Styled(WithEuiTheme(EuiAccordionClass))' + ) ).toHaveLength(1); }); }); diff --git a/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.tsx b/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.tsx index b132239902f9d..8a24405a586ba 100644 --- a/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.tsx +++ b/x-pack/plugins/apm/public/components/shared/stacktrace/cause_stacktrace.tsx @@ -30,7 +30,7 @@ const CausedByHeading = euiStyled('span')` `; const FramesContainer = euiStyled('div')` - padding-left: ${({ theme }) => theme.eui.paddingSizes.m}; + padding-left: ${({ theme }) => theme.eui.euiSizeM}; `; function CausedBy({ message }: { message: string }) { diff --git a/x-pack/plugins/apm/public/components/shared/stacktrace/context.tsx b/x-pack/plugins/apm/public/components/shared/stacktrace/context.tsx index 9ba8919affc74..7c8688969f05f 100644 --- a/x-pack/plugins/apm/public/components/shared/stacktrace/context.tsx +++ b/x-pack/plugins/apm/public/components/shared/stacktrace/context.tsx @@ -49,8 +49,8 @@ const LineNumberContainer = euiStyled.div<{ isLibraryFrame: boolean }>` const LineNumber = euiStyled.div<{ highlight: boolean }>` position: relative; min-width: 42px; - padding-left: ${({ theme }) => theme.eui.paddingSizes.s}; - padding-right: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding-left: ${({ theme }) => theme.eui.euiSizeS}; + padding-right: ${({ theme }) => theme.eui.euiSizeXS}; color: ${({ theme }) => theme.eui.euiColorMediumShade}; line-height: ${LINE_HEIGHT}px; text-align: right; diff --git a/x-pack/plugins/apm/public/components/shared/stacktrace/variables.tsx b/x-pack/plugins/apm/public/components/shared/stacktrace/variables.tsx index 2844589cc60a8..9b7ddea51de44 100644 --- a/x-pack/plugins/apm/public/components/shared/stacktrace/variables.tsx +++ b/x-pack/plugins/apm/public/components/shared/stacktrace/variables.tsx @@ -17,8 +17,7 @@ const VariablesContainer = euiStyled.div` background: ${({ theme }) => theme.eui.euiColorEmptyShade}; border-radius: 0 0 ${({ theme }) => `${theme.eui.euiBorderRadiusSmall} ${theme.eui.euiBorderRadiusSmall}`}; - padding: ${({ theme }) => - `${theme.eui.paddingSizes.s} ${theme.eui.paddingSizes.m}`}; + padding: ${({ theme }) => `${theme.eui.euiSizeS} ${theme.eui.euiSizeM}`}; `; interface Props { diff --git a/x-pack/plugins/apm/public/components/shared/summary/index.tsx b/x-pack/plugins/apm/public/components/shared/summary/index.tsx index 649d9bdb66447..e0f6c1e090978 100644 --- a/x-pack/plugins/apm/public/components/shared/summary/index.tsx +++ b/x-pack/plugins/apm/public/components/shared/summary/index.tsx @@ -17,7 +17,7 @@ interface Props { const Item = euiStyled(EuiFlexItem)` flex-wrap: nowrap; border-right: 1px solid ${({ theme }) => theme.eui.euiColorLightShade}; - padding-right: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-right: ${({ theme }) => theme.eui.euiSizeS}; flex-flow: row nowrap; line-height: 1.5; align-items: center !important; diff --git a/x-pack/plugins/apm/public/components/shared/time_comparison/index.tsx b/x-pack/plugins/apm/public/components/shared/time_comparison/index.tsx index 8b49fe388bcf2..ed157810f0617 100644 --- a/x-pack/plugins/apm/public/components/shared/time_comparison/index.tsx +++ b/x-pack/plugins/apm/public/components/shared/time_comparison/index.tsx @@ -30,7 +30,7 @@ const PrependContainer = euiStyled.div` align-items: center; background-color: ${({ theme }) => theme.eui.euiFormInputGroupLabelBackground}; - padding: 0 ${({ theme }) => theme.eui.paddingSizes.m}; + padding: 0 ${({ theme }) => theme.eui.euiSizeM}; `; export function TimeComparison() { diff --git a/x-pack/plugins/apm/scripts/create_apm_users.js b/x-pack/plugins/apm/scripts/create_apm_users.js index 37a70c70ef3b0..8cef6ebb6c7ae 100644 --- a/x-pack/plugins/apm/scripts/create_apm_users.js +++ b/x-pack/plugins/apm/scripts/create_apm_users.js @@ -7,8 +7,8 @@ /* * This script will create two users - * - editor_user - * - viewer_user + * - editor + * - viewer * * Usage: node create-apm-users.js ******************************/ diff --git a/x-pack/plugins/apm/scripts/create_apm_users/create_apm_users.ts b/x-pack/plugins/apm/scripts/create_apm_users/create_apm_users.ts index f7d0ea2e78ed8..7532392c9a8b4 100644 --- a/x-pack/plugins/apm/scripts/create_apm_users/create_apm_users.ts +++ b/x-pack/plugins/apm/scripts/create_apm_users/create_apm_users.ts @@ -42,8 +42,8 @@ export async function createApmUsers({ // user definitions const users = [ - { username: 'viewer_user', roles: ['viewer'] }, - { username: 'editor_user', roles: ['editor'] }, + { username: 'viewer', roles: ['viewer'] }, + { username: 'editor', roles: ['editor'] }, ]; // create users diff --git a/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot b/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot index e82b6bf082b05..6fe10111cf188 100644 --- a/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot +++ b/x-pack/plugins/canvas/canvas_plugin_src/renderers/filters/time_filter/components/__stories__/__snapshots__/time_filter.stories.storyshot @@ -195,16 +195,16 @@ exports[`Storyshots renderers/TimeFilter with absolute time bounds 1`] = `
-
-
- → -
-
+ + +
@@ -573,16 +573,16 @@ exports[`Storyshots renderers/TimeFilter with relative time bounds 1`] = `
-
-
- → -
-
+ + +
diff --git a/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/axis_config/__stories__/__snapshots__/extended_template.stories.storyshot b/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/axis_config/__stories__/__snapshots__/extended_template.stories.storyshot index 38ea65195ee1c..3ea98bee12639 100644 --- a/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/axis_config/__stories__/__snapshots__/extended_template.stories.storyshot +++ b/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/axis_config/__stories__/__snapshots__/extended_template.stories.storyshot @@ -171,16 +171,12 @@ exports[`Storyshots arguments/AxisConfig/components extended disabled 1`] = ` } >
-
-

- Switch on to view axis settings -

-
+

+ Switch on to view axis settings +

`; diff --git a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot index 515fc29fc9d56..f04bd35abd188 100644 --- a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset.stories.storyshot @@ -12,7 +12,7 @@ exports[`Storyshots components/Assets/Asset airplane 1`] = ` className="euiFlexItem" >


@@ -199,7 +199,7 @@ exports[`Storyshots components/Assets/Asset marker 1`] = ` className="euiFlexItem" >


diff --git a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset_manager.stories.storyshot b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset_manager.stories.storyshot index 8252d2e3aed45..b1352056915a9 100644 --- a/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset_manager.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/asset_manager/__stories__/__snapshots__/asset_manager.stories.storyshot @@ -96,25 +96,21 @@ exports[`Storyshots components/Assets/AssetManager no assets 1`] = ` className="euiModalBody__overflow" >

-
-

- Below are the image assets in this workpad. Any assets that are currently in use cannot be determined at this time. To reclaim space, delete assets. -

-
+

+ Below are the image assets in this workpad. Any assets that are currently in use cannot be determined at this time. To reclaim space, delete assets. +

0% space used @@ -300,16 +296,12 @@ exports[`Storyshots components/Assets/AssetManager two assets 1`] = ` className="euiModalBody__overflow" >
-
-

- Below are the image assets in this workpad. Any assets that are currently in use cannot be determined at this time. To reclaim space, delete assets. -

-
+

+ Below are the image assets in this workpad. Any assets that are currently in use cannot be determined at this time. To reclaim space, delete assets. +


@@ -497,7 +489,7 @@ exports[`Storyshots components/Assets/AssetManager two assets 1`] = ` className="euiFlexItem" >


@@ -694,7 +686,7 @@ exports[`Storyshots components/Assets/AssetManager two assets 1`] = ` className="euiFlexItem euiFlexItem--flexGrowZero eui-textNoWrap" >

0% space used diff --git a/x-pack/plugins/canvas/public/components/custom_element_modal/__stories__/__snapshots__/custom_element_modal.stories.storyshot b/x-pack/plugins/canvas/public/components/custom_element_modal/__stories__/__snapshots__/custom_element_modal.stories.storyshot index 229ad82b350ee..55ed666cdaa90 100644 --- a/x-pack/plugins/canvas/public/components/custom_element_modal/__stories__/__snapshots__/custom_element_modal.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/custom_element_modal/__stories__/__snapshots__/custom_element_modal.stories.storyshot @@ -200,7 +200,7 @@ exports[`Storyshots components/Elements/CustomElementModal with description 1`]

Take a screenshot of your element and upload it here. This can also be done after saving. @@ -219,7 +219,7 @@ exports[`Storyshots components/Elements/CustomElementModal with description 1`] className="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

@@ -517,7 +517,7 @@ exports[`Storyshots components/Elements/CustomElementModal with image 1`] = `

Take a screenshot of your element and upload it here. This can also be done after saving. @@ -536,7 +536,7 @@ exports[`Storyshots components/Elements/CustomElementModal with image 1`] = ` className="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

Take a screenshot of your element and upload it here. This can also be done after saving. @@ -848,7 +848,7 @@ exports[`Storyshots components/Elements/CustomElementModal with name 1`] = ` className="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

Take a screenshot of your element and upload it here. This can also be done after saving. @@ -1157,7 +1157,7 @@ exports[`Storyshots components/Elements/CustomElementModal with title 1`] = ` className="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

-
-

- The datasource has an argument controlled by an expression. Use the expression editor to modify the datasource. -

-
+

+ The datasource has an argument controlled by an expression. Use the expression editor to modify the datasource. +

diff --git a/x-pack/plugins/canvas/public/components/element_card/__stories__/__snapshots__/element_card.stories.storyshot b/x-pack/plugins/canvas/public/components/element_card/__stories__/__snapshots__/element_card.stories.storyshot index d07f8b44feb62..c02fdeeb3fa85 100644 --- a/x-pack/plugins/canvas/public/components/element_card/__stories__/__snapshots__/element_card.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/element_card/__stories__/__snapshots__/element_card.stories.storyshot @@ -9,7 +9,7 @@ exports[`Storyshots components/Elements/ElementCard with click handler 1`] = ` } >

@@ -64,7 +64,7 @@ exports[`Storyshots components/Elements/ElementCard with image 1`] = ` } >

@@ -112,7 +112,7 @@ exports[`Storyshots components/Elements/ElementCard with tags 1`] = ` } >

@@ -282,7 +282,7 @@ exports[`Storyshots components/Elements/ElementCard with title and description 1 } >

diff --git a/x-pack/plugins/canvas/public/components/home/__snapshots__/home.stories.storyshot b/x-pack/plugins/canvas/public/components/home/__snapshots__/home.stories.storyshot index 3655c2e693353..b53ae524a7219 100644 --- a/x-pack/plugins/canvas/public/components/home/__snapshots__/home.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/home/__snapshots__/home.stories.storyshot @@ -119,7 +119,7 @@ exports[`Storyshots Home Home Page 1`] = `

Add your first workpad - +
-
-
-

- Create a new workpad, start from a template, or import a workpad JSON file by dropping it here. -

-

- New to Canvas? - - - Add your first workpad - - . -

-
- +

+ Create a new workpad, start from a template, or import a workpad JSON file by dropping it here. +

+

+ New to Canvas? + + + Add your first workpad + + . +

+
diff --git a/x-pack/plugins/canvas/public/components/home/my_workpads/__snapshots__/my_workpads.stories.storyshot b/x-pack/plugins/canvas/public/components/home/my_workpads/__snapshots__/my_workpads.stories.storyshot index 61ee76f0f2450..f8f2252a098cc 100644 --- a/x-pack/plugins/canvas/public/components/home/my_workpads/__snapshots__/my_workpads.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/home/my_workpads/__snapshots__/my_workpads.stories.storyshot @@ -2,7 +2,7 @@ exports[`Storyshots Home/Tabs/My Workpads My Workpads 1`] = `

@@ -126,7 +126,7 @@ exports[`Storyshots components/SavedElementsModal/ElementGrid default 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

@@ -237,7 +237,7 @@ exports[`Storyshots components/SavedElementsModal/ElementGrid default 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

diff --git a/x-pack/plugins/canvas/public/components/saved_elements_modal/__stories__/__snapshots__/saved_elements_modal.stories.storyshot b/x-pack/plugins/canvas/public/components/saved_elements_modal/__stories__/__snapshots__/saved_elements_modal.stories.storyshot index 0ebe1be89972f..b763f274433bf 100644 --- a/x-pack/plugins/canvas/public/components/saved_elements_modal/__stories__/__snapshots__/saved_elements_modal.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/saved_elements_modal/__stories__/__snapshots__/saved_elements_modal.stories.storyshot @@ -91,7 +91,7 @@ exports[`Storyshots components/SavedElementsModal no custom elements 1`] = ` className="euiSpacer euiSpacer--l css-p2o3x6-euiSpacer-l" />

Add new elements - +
-
-
-

- Group and save workpad elements to create new elements -

-
- +

+ Group and save workpad elements to create new elements +

+
@@ -267,7 +263,7 @@ exports[`Storyshots components/SavedElementsModal with custom elements 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

@@ -378,7 +374,7 @@ exports[`Storyshots components/SavedElementsModal with custom elements 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

@@ -489,7 +485,7 @@ exports[`Storyshots components/SavedElementsModal with custom elements 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

@@ -745,7 +741,7 @@ exports[`Storyshots components/SavedElementsModal with text filter 1`] = ` className="euiFlexItem canvasElementCard__wrapper" >

diff --git a/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot b/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot index 4f2d16975521d..6059fa1cd5c15 100644 --- a/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/shape_picker_popover/__stories__/__snapshots__/shape_picker_popover.stories.storyshot @@ -8,7 +8,7 @@ exports[`Storyshots components/Shapes/ShapePickerPopover default 1`] = ` className="euiPopover__anchor" >

`; @@ -92,18 +68,10 @@ exports[`Storyshots components/ToolTipShortcut with left arrow 1`] = ` } >
-
-
- ← -
-
+ ←
`; @@ -119,18 +87,10 @@ exports[`Storyshots components/ToolTipShortcut with right arrow 1`] = ` } >
-
-
- → -
-
+ →
`; @@ -146,18 +106,10 @@ exports[`Storyshots components/ToolTipShortcut with shortcut 1`] = ` } >
-
-
- G -
-
+ G
`; @@ -173,18 +125,10 @@ exports[`Storyshots components/ToolTipShortcut with up arrow 1`] = ` } >
-
-
- ⌘ + SHIFT + ↑ -
-
+ ⌘ + SHIFT + ↑
`; diff --git a/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/delete_var.stories.storyshot b/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/delete_var.stories.storyshot index bfcb274d3e343..1b4ab35de123e 100644 --- a/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/delete_var.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/delete_var.stories.storyshot @@ -44,14 +44,10 @@ Array [ className="euiFlexItem euiFlexItem--flexGrowZero" >
-
- Deleting this variable may adversely affect the workpad. Are you sure you wish to continue? -
+ Deleting this variable may adversely affect the workpad. Are you sure you wish to continue?
diff --git a/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/edit_var.stories.storyshot b/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/edit_var.stories.storyshot index e99d6d658d45f..e21f422723c1c 100644 --- a/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/edit_var.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/var_config/__stories__/__snapshots__/edit_var.stories.storyshot @@ -38,7 +38,7 @@ Array [ >

Type @@ -32,7 +32,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >
exactly
@@ -46,7 +46,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >

Column @@ -62,7 +62,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >
project
@@ -76,7 +76,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >

Value @@ -92,7 +92,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >
kibana
@@ -106,7 +106,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >

Filter group @@ -122,7 +122,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` } >
Group 1
@@ -133,7 +133,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent default 1`] = ` exports[`Storyshots components/WorkpadFilters/FilterComponent with component field 1`] = `

Type @@ -163,7 +163,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >
exactly
@@ -177,7 +177,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >

Column @@ -193,7 +193,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >
project
@@ -207,7 +207,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >

Value @@ -223,13 +223,13 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >

@@ -248,7 +248,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >

Filter group @@ -264,7 +264,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie } >
Group 1
@@ -275,7 +275,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with component fie exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter fields 1`] = `

Type @@ -305,7 +305,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >
exactly
@@ -319,7 +319,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >

Column @@ -335,7 +335,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >
project
@@ -349,7 +349,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >

Value @@ -365,7 +365,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >
kibana
@@ -379,7 +379,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >

Filter group @@ -395,7 +395,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >
Group 1
@@ -409,7 +409,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >

Custom Field @@ -425,7 +425,7 @@ exports[`Storyshots components/WorkpadFilters/FilterComponent with custom filter } >
Some unknown field
diff --git a/x-pack/plugins/canvas/public/components/workpad_filters/__stories__/__snapshots__/filters_group.component.stories.storyshot b/x-pack/plugins/canvas/public/components/workpad_filters/__stories__/__snapshots__/filters_group.component.stories.storyshot index 57fbd4c2109cd..ea2946f0200f8 100644 --- a/x-pack/plugins/canvas/public/components/workpad_filters/__stories__/__snapshots__/filters_group.component.stories.storyshot +++ b/x-pack/plugins/canvas/public/components/workpad_filters/__stories__/__snapshots__/filters_group.component.stories.storyshot @@ -16,13 +16,13 @@ exports[`Storyshots components/WorkpadFilters/FiltersGroupComponent default 1`] } >

markdown mock
My Canvas Workpad

" +
markdown mock

My Canvas Workpad

" `; exports[`Canvas Shareable Workpad API Placed successfully with height specified 1`] = `"
"`; @@ -21,7 +21,7 @@ exports[`Canvas Shareable Workpad API Placed successfully with height specified
markdown mock
markdown mock
My Canvas Workpad
" +
markdown mock
My Canvas Workpad
" `; exports[`Canvas Shareable Workpad API Placed successfully with page specified 1`] = `"
"`; @@ -33,7 +33,7 @@ exports[`Canvas Shareable Workpad API Placed successfully with page specified 2`
markdown mock
markdown mock
My Canvas Workpad
" +
markdown mock
My Canvas Workpad
" `; exports[`Canvas Shareable Workpad API Placed successfully with width and height specified 1`] = `"
"`; @@ -45,7 +45,7 @@ exports[`Canvas Shareable Workpad API Placed successfully with width and height
markdown mock
markdown mock
My Canvas Workpad
" +
markdown mock
My Canvas Workpad
" `; exports[`Canvas Shareable Workpad API Placed successfully with width specified 1`] = `"
"`; @@ -57,5 +57,5 @@ exports[`Canvas Shareable Workpad API Placed successfully with width specified 2
markdown mock
markdown mock
My Canvas Workpad
" +
markdown mock
My Canvas Workpad
" `; diff --git a/x-pack/plugins/canvas/shareable_runtime/components/__stories__/__snapshots__/canvas.stories.storyshot b/x-pack/plugins/canvas/shareable_runtime/components/__stories__/__snapshots__/canvas.stories.storyshot index 425a5311c74f9..b3ab4e04a32d6 100644 --- a/x-pack/plugins/canvas/shareable_runtime/components/__stories__/__snapshots__/canvas.stories.storyshot +++ b/x-pack/plugins/canvas/shareable_runtime/components/__stories__/__snapshots__/canvas.stories.storyshot @@ -1342,17 +1342,13 @@ exports[`Storyshots shareables/Canvas component 1`] = ` } >
-
- Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes -
+ Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes
@@ -1411,16 +1407,12 @@ exports[`Storyshots shareables/Canvas component 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 28 -
+ Page + 1 + of 28
@@ -2832,17 +2824,13 @@ exports[`Storyshots shareables/Canvas contextual: austin 1`] = ` } >
-
- Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes -
+ Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes
@@ -2901,16 +2889,12 @@ exports[`Storyshots shareables/Canvas contextual: austin 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 28 -
+ Page + 1 + of 28
@@ -3138,17 +3122,13 @@ exports[`Storyshots shareables/Canvas contextual: hello 1`] = ` } >
-
- My Canvas Workpad -
+ My Canvas Workpad
@@ -3207,15 +3187,11 @@ exports[`Storyshots shareables/Canvas contextual: hello 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 -
+ Page + 1
diff --git a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/footer.stories.storyshot b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/footer.stories.storyshot index ff71dcc92d5a6..0b92eb8357f35 100644 --- a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/footer.stories.storyshot +++ b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/footer.stories.storyshot @@ -1295,17 +1295,13 @@ exports[`Storyshots shareables/Footer contextual: austin 1`] = ` } >
-
- Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes -
+ Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes
@@ -1364,16 +1360,12 @@ exports[`Storyshots shareables/Footer contextual: austin 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 28 -
+ Page + 1 + of 28
@@ -1555,17 +1547,13 @@ exports[`Storyshots shareables/Footer contextual: hello 1`] = ` } >
-
- My Canvas Workpad -
+ My Canvas Workpad
@@ -1624,15 +1612,11 @@ exports[`Storyshots shareables/Footer contextual: hello 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 -
+ Page + 1
diff --git a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/page_controls.stories.storyshot b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/page_controls.stories.storyshot index f2b92754b6d6f..4acf22b3e3fc2 100644 --- a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/page_controls.stories.storyshot +++ b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/page_controls.stories.storyshot @@ -56,16 +56,12 @@ exports[`Storyshots shareables/Footer/PageControls component 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 10 -
+ Page + 1 + of 10
@@ -157,16 +153,12 @@ exports[`Storyshots shareables/Footer/PageControls contextual: austin 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 28 -
+ Page + 1 + of 28
@@ -258,16 +250,12 @@ exports[`Storyshots shareables/Footer/PageControls contextual: hello 1`] = ` className="euiButtonEmpty__text" >
-
- Page - 1 - of 28 -
+ Page + 1 + of 28
diff --git a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/title.stories.storyshot b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/title.stories.storyshot index 6d50d0b00fcad..069f58bdee1c5 100644 --- a/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/title.stories.storyshot +++ b/x-pack/plugins/canvas/shareable_runtime/components/footer/__stories__/__snapshots__/title.stories.storyshot @@ -49,17 +49,13 @@ exports[`Storyshots shareables/Footer/Title component 1`] = ` } >
-
- This is a test title. -
+ This is a test title.
@@ -116,17 +112,13 @@ exports[`Storyshots shareables/Footer/Title contextual: austin 1`] = ` } >
-
- Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes -
+ Elastic{ON} - Austin from Clint Andrew Hall with a title that just goes and goes and goes
@@ -183,17 +175,13 @@ exports[`Storyshots shareables/Footer/Title contextual: hello 1`] = ` } >
-
- My Canvas Workpad -
+ My Canvas Workpad
diff --git a/x-pack/plugins/canvas/shareable_runtime/components/footer/settings/__snapshots__/settings.test.tsx.snap b/x-pack/plugins/canvas/shareable_runtime/components/footer/settings/__snapshots__/settings.test.tsx.snap index f89c77601e375..451f12c25b7ce 100644 --- a/x-pack/plugins/canvas/shareable_runtime/components/footer/settings/__snapshots__/settings.test.tsx.snap +++ b/x-pack/plugins/canvas/shareable_runtime/components/footer/settings/__snapshots__/settings.test.tsx.snap @@ -9,7 +9,7 @@ exports[` can navigate Autoplay Settings 1`] = ` aria-describedby="generated-id" aria-live="off" aria-modal="true" - class="euiPanel euiPanel--borderRadiusMedium euiPanel--plain euiPanel--noShadow euiPopover__panel euiPopover__panel--top" + class="euiPanel euiPanel--plain euiPopover__panel euiPopover__panel--top css-1pupmsc-euiPanel-grow-m-plain" data-popover-panel="true" role="dialog" style="top: -16px; left: -22px; will-change: transform, opacity; z-index: 2000;" @@ -108,7 +108,7 @@ exports[` can navigate Autoplay Settings 2`] = ` aria-describedby="generated-id" aria-live="off" aria-modal="true" - class="euiPanel euiPanel--borderRadiusMedium euiPanel--plain euiPanel--noShadow euiPopover__panel euiPopover__panel--top euiPopover__panel-isOpen" + class="euiPanel euiPanel--plain euiPopover__panel euiPopover__panel--top euiPopover__panel-isOpen css-1pupmsc-euiPanel-grow-m-plain" data-popover-panel="true" role="dialog" style="top: -16px; left: -22px; z-index: 2000;" @@ -360,7 +360,7 @@ exports[` can navigate Toolbar Settings, closes when activated 1`] = aria-describedby="generated-id" aria-live="off" aria-modal="true" - class="euiPanel euiPanel--borderRadiusMedium euiPanel--plain euiPanel--noShadow euiPopover__panel euiPopover__panel--top" + class="euiPanel euiPanel--plain euiPopover__panel euiPopover__panel--top css-1pupmsc-euiPanel-grow-m-plain" data-popover-panel="true" role="dialog" style="top: -16px; left: -22px; will-change: transform, opacity; z-index: 2000;" @@ -459,7 +459,7 @@ exports[` can navigate Toolbar Settings, closes when activated 2`] = aria-describedby="generated-id" aria-live="off" aria-modal="true" - class="euiPanel euiPanel--borderRadiusMedium euiPanel--plain euiPanel--noShadow euiPopover__panel euiPopover__panel--top euiPopover__panel-isOpen" + class="euiPanel euiPanel--plain euiPopover__panel euiPopover__panel--top euiPopover__panel-isOpen css-1pupmsc-euiPanel-grow-m-plain" data-popover-panel="true" role="dialog" style="top: -16px; left: -22px; z-index: 2000;" @@ -635,4 +635,4 @@ exports[` can navigate Toolbar Settings, closes when activated 2`] =
`; -exports[` can navigate Toolbar Settings, closes when activated 3`] = `"

You are in a dialog. To close this dialog, hit escape.

Settings
Hide Toolbar
Hide the toolbar when the mouse is not within the Canvas?
"`; +exports[` can navigate Toolbar Settings, closes when activated 3`] = `"

You are in a dialog. To close this dialog, hit escape.

Settings
Hide Toolbar
Hide the toolbar when the mouse is not within the Canvas?
"`; diff --git a/x-pack/plugins/cases/public/components/all_cases/table.tsx b/x-pack/plugins/cases/public/components/all_cases/table.tsx index ce3442e734b43..6d76e009403b8 100644 --- a/x-pack/plugins/cases/public/components/all_cases/table.tsx +++ b/x-pack/plugins/cases/public/components/all_cases/table.tsx @@ -46,7 +46,7 @@ interface CasesTableProps { } const Div = styled.div` - margin-top: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-top: ${({ theme }) => theme.eui.euiSizeM}; `; export const CasesTable: FunctionComponent = ({ diff --git a/x-pack/plugins/cases/public/components/configure_cases/index.tsx b/x-pack/plugins/cases/public/components/configure_cases/index.tsx index 2c04f9f0aa7da..e7542ba39f382 100644 --- a/x-pack/plugins/cases/public/components/configure_cases/index.tsx +++ b/x-pack/plugins/cases/public/components/configure_cases/index.tsx @@ -42,8 +42,8 @@ const FormWrapper = styled.div` margin-top: 0; } - padding-top: ${theme.eui.paddingSizes.xl}; - padding-bottom: ${theme.eui.paddingSizes.xl}; + padding-top: ${theme.eui.euiSizeXL}; + padding-bottom: ${theme.eui.euiSizeXL}; .euiFlyout { z-index: ${theme.eui.euiZNavigation + 1}; } diff --git a/x-pack/plugins/cases/public/components/create/flyout/create_case_flyout.tsx b/x-pack/plugins/cases/public/components/create/flyout/create_case_flyout.tsx index 148cfa119bebd..94e72c43f6ad9 100644 --- a/x-pack/plugins/cases/public/components/create/flyout/create_case_flyout.tsx +++ b/x-pack/plugins/cases/public/components/create/flyout/create_case_flyout.tsx @@ -60,7 +60,7 @@ const StyledEuiFlyoutBody = styled(EuiFlyoutBody)` && .euiFlyoutBody__overflowContent { display: block; - padding: ${theme.eui.paddingSizes.l} ${theme.eui.paddingSizes.l} 70px; + padding: ${theme.eui.euiSizeL} ${theme.eui.euiSizeL} 70px; height: auto; } `} diff --git a/x-pack/plugins/cases/public/components/header_page/index.test.tsx b/x-pack/plugins/cases/public/components/header_page/index.test.tsx index 55ca3671ce974..707cb9b7c4335 100644 --- a/x-pack/plugins/cases/public/components/header_page/index.test.tsx +++ b/x-pack/plugins/cases/public/components/header_page/index.test.tsx @@ -124,7 +124,7 @@ describe('HeaderPage', () => { const casesHeaderPage = wrapper.find('.casesHeaderPage').first(); expect(casesHeaderPage).toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(casesHeaderPage).toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.l); + expect(casesHeaderPage).toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeL); }); test('it DOES NOT apply border styles when border is false', () => { @@ -136,7 +136,7 @@ describe('HeaderPage', () => { const casesHeaderPage = wrapper.find('.casesHeaderPage').first(); expect(casesHeaderPage).not.toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(casesHeaderPage).not.toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.l); + expect(casesHeaderPage).not.toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeL); }); describe('Badges', () => { diff --git a/x-pack/plugins/cases/public/components/header_page/index.tsx b/x-pack/plugins/cases/public/components/header_page/index.tsx index 7d0bf6a4cb9c5..6bec4035ca823 100644 --- a/x-pack/plugins/cases/public/components/header_page/index.tsx +++ b/x-pack/plugins/cases/public/components/header_page/index.tsx @@ -30,9 +30,9 @@ const Header = styled.header.attrs({ ${border && css` border-bottom: ${theme.eui.euiBorderThin}; - padding-bottom: ${theme.eui.paddingSizes.l}; + padding-bottom: ${theme.eui.euiSizeL}; .euiProgress { - top: ${theme.eui.paddingSizes.l}; + top: ${theme.eui.euiSizeL}; } `} `} diff --git a/x-pack/plugins/cases/public/components/user_actions/index.tsx b/x-pack/plugins/cases/public/components/user_actions/index.tsx index 8dfa0a5ca84c4..7d59d5ba58a50 100644 --- a/x-pack/plugins/cases/public/components/user_actions/index.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/index.tsx @@ -58,8 +58,8 @@ const MyEuiCommentList = styled(EuiCommentList)` & .comment-alert .euiCommentEvent { background-color: ${theme.eui.euiColorLightestShade}; border: ${theme.eui.euiFlyoutBorder}; - padding: ${theme.eui.paddingSizes.s}; - border-radius: ${theme.eui.paddingSizes.xs}; + padding: ${theme.eui.euiSizeS}; + border-radius: ${theme.eui.euiSizeXS}; } & .comment-alert .euiCommentEvent__headerData { @@ -69,7 +69,7 @@ const MyEuiCommentList = styled(EuiCommentList)` & .comment-action.empty-comment .euiCommentEvent--regular { box-shadow: none; .euiCommentEvent__header { - padding: ${theme.eui.euiSizeM} ${theme.eui.paddingSizes.s}; + padding: ${theme.eui.euiSizeM} ${theme.eui.euiSizeS}; border-bottom: 0; } } diff --git a/x-pack/plugins/cases/public/components/utility_bar/styles.tsx b/x-pack/plugins/cases/public/components/utility_bar/styles.tsx index 158f0c5ebea15..4c4427ba23471 100644 --- a/x-pack/plugins/cases/public/components/utility_bar/styles.tsx +++ b/x-pack/plugins/cases/public/components/utility_bar/styles.tsx @@ -30,7 +30,7 @@ export const Bar = styled.aside.attrs({ ${border && css` border-bottom: ${theme.eui.euiBorderThin}; - padding-bottom: ${theme.eui.paddingSizes.s}; + padding-bottom: ${theme.eui.euiSizeS}; `} @media only screen and (min-width: ${theme.eui.euiBreakpoints.l}) { @@ -83,8 +83,8 @@ export const BarGroup = styled.div.attrs({ @media only screen and (min-width: ${theme.eui.euiBreakpoints.m}) { border-right: ${theme.eui.euiBorderThin}; flex-wrap: nowrap; - margin-right: ${theme.eui.paddingSizes.m}; - padding-right: ${theme.eui.paddingSizes.m}; + margin-right: ${theme.eui.euiSizeM}; + padding-right: ${theme.eui.euiSizeM}; & + & { margin-top: 0; diff --git a/x-pack/plugins/cases/public/components/utility_bar/utility_bar.test.tsx b/x-pack/plugins/cases/public/components/utility_bar/utility_bar.test.tsx index 545b1f4ae13c2..62988a7a9dd76 100644 --- a/x-pack/plugins/cases/public/components/utility_bar/utility_bar.test.tsx +++ b/x-pack/plugins/cases/public/components/utility_bar/utility_bar.test.tsx @@ -74,7 +74,7 @@ describe('UtilityBar', () => { const casesUtilityBar = wrapper.find('.casesUtilityBar').first(); expect(casesUtilityBar).toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(casesUtilityBar).toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.s); + expect(casesUtilityBar).toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeS); }); test('it DOES NOT apply border styles when border is false', () => { @@ -104,6 +104,6 @@ describe('UtilityBar', () => { const casesUtilityBar = wrapper.find('.casesUtilityBar').first(); expect(casesUtilityBar).not.toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(casesUtilityBar).not.toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.s); + expect(casesUtilityBar).not.toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeS); }); }); diff --git a/x-pack/plugins/cases/public/components/wrappers/index.tsx b/x-pack/plugins/cases/public/components/wrappers/index.tsx index 54c575ab95316..c937d3e48729f 100644 --- a/x-pack/plugins/cases/public/components/wrappers/index.tsx +++ b/x-pack/plugins/cases/public/components/wrappers/index.tsx @@ -28,7 +28,7 @@ const gutterTimeline = '70px'; // seems to be a timeline reference from the orig export const ContentWrapper = styled.div` ${({ theme }) => ` - padding: ${theme.eui.paddingSizes.l} 0 ${gutterTimeline} 0; + padding: ${theme.eui.euiSizeL} 0 ${gutterTimeline} 0; `}; `; diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_distribution_bar.tsx b/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_distribution_bar.tsx index d1eb97832ab7c..647b5b4ea0464 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_distribution_bar.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/layout/findings_distribution_bar.tsx @@ -106,7 +106,7 @@ const DistributionBar: React.FC> = ({ passe gutterSize="none" css={css` height: 8px; - background: ${euiTheme.colors.subdued}; + background: ${euiTheme.colors.subduedText}; `} > diff --git a/x-pack/plugins/data_visualizer/common/types/field_stats.ts b/x-pack/plugins/data_visualizer/common/types/field_stats.ts index 9cc1f7d84f4e2..75fa662281fb3 100644 --- a/x-pack/plugins/data_visualizer/common/types/field_stats.ts +++ b/x-pack/plugins/data_visualizer/common/types/field_stats.ts @@ -8,7 +8,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { Query } from '@kbn/es-query'; import { IKibanaSearchResponse } from '@kbn/data-plugin/common'; -import { isPopulatedObject } from '../utils/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { TimeBucketsInterval } from '../services/time_buckets'; export interface FieldData { diff --git a/x-pack/plugins/data_visualizer/common/types/index.ts b/x-pack/plugins/data_visualizer/common/types/index.ts index 6ab0649bfb9e6..395c9f2f595c2 100644 --- a/x-pack/plugins/data_visualizer/common/types/index.ts +++ b/x-pack/plugins/data_visualizer/common/types/index.ts @@ -6,7 +6,7 @@ */ import type { SimpleSavedObject } from '@kbn/core/public'; -import { isPopulatedObject } from '../utils/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export type { JobFieldType } from './job_field_type'; export type { FieldRequestConfig, diff --git a/x-pack/plugins/data_visualizer/common/utils/object_utils.ts b/x-pack/plugins/data_visualizer/common/utils/object_utils.ts deleted file mode 100644 index 537ee9202b4de..0000000000000 --- a/x-pack/plugins/data_visualizer/common/utils/object_utils.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -/* - * A type guard to check record like object structures. - * - * Examples: - * - `isPopulatedObject({...})` - * Limits type to Record - * - * - `isPopulatedObject({...}, ['attribute'])` - * Limits type to Record<'attribute', unknown> - * - * - `isPopulatedObject({...})` - * Limits type to a record with keys of the given interface. - * Note that you might want to add keys from the interface to the - * array of requiredAttributes to satisfy runtime requirements. - * Otherwise you'd just satisfy TS requirements but might still - * run into runtime issues. - */ -export const isPopulatedObject = ( - arg: unknown, - requiredAttributes: U[] = [] -): arg is Record => { - return ( - typeof arg === 'object' && - arg !== null && - Object.keys(arg).length > 0 && - (requiredAttributes.length === 0 || - requiredAttributes.every((d) => ({}.hasOwnProperty.call(arg, d)))) - ); -}; diff --git a/x-pack/plugins/data_visualizer/common/utils/query_utils.ts b/x-pack/plugins/data_visualizer/common/utils/query_utils.ts index dc21bbcae96c3..9f0f746f8909b 100644 --- a/x-pack/plugins/data_visualizer/common/utils/query_utils.ts +++ b/x-pack/plugins/data_visualizer/common/utils/query_utils.ts @@ -40,35 +40,6 @@ export function buildBaseFilterCriteria( return filterCriteria; } -// Wraps the supplied aggregations in a sampler aggregation. -// A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) -// of less than 1 indicates no sampling, and the aggs are returned as-is. -export function buildSamplerAggregation( - aggs: any, - samplerShardSize: number -): Record { - if (samplerShardSize < 1) { - return aggs; - } - - return { - sample: { - sampler: { - shard_size: samplerShardSize, - }, - aggs, - }, - }; -} - -// Returns the path of aggregations in the elasticsearch response, as an array, -// depending on whether sampling is being used. -// A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) -// of less than 1 indicates no sampling, and an empty array is returned. -export function getSamplerAggregationsResponsePath(samplerShardSize: number): string[] { - return samplerShardSize > 0 ? ['sample'] : []; -} - // Returns a name which is safe to use in elasticsearch aggregations for the supplied // field name. Aggregation names must be alpha-numeric and can only contain '_' and '-' characters, // so if the supplied field names contains disallowed characters, the provided index diff --git a/x-pack/plugins/data_visualizer/common/utils/runtime_field_utils.ts b/x-pack/plugins/data_visualizer/common/utils/runtime_field_utils.ts index 6b2cb78d73274..10179d5e51732 100644 --- a/x-pack/plugins/data_visualizer/common/utils/runtime_field_utils.ts +++ b/x-pack/plugins/data_visualizer/common/utils/runtime_field_utils.ts @@ -6,7 +6,7 @@ */ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { RUNTIME_FIELD_TYPES } from '@kbn/data-plugin/common'; -import { isPopulatedObject } from './object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; type RuntimeType = typeof RUNTIME_FIELD_TYPES[number]; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts index c7cfc11c4d630..36b84afadfb04 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/full_time_range_selector/full_time_range_selector_service.ts @@ -12,7 +12,7 @@ import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; import { i18n } from '@kbn/i18n'; import type { ToastsStart } from '@kbn/core/public'; import { DataView } from '@kbn/data-views-plugin/public'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { getTimeFieldRange } from '../../services/time_field_range'; import type { GetTimeFieldRangeResponse } from '../../../../../common/types/time_field_request'; import { addExcludeFrozenToQuery } from '../../utils/query_utils'; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_boolean_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_boolean_field_stats.ts index bceb354295d9c..5b91d3716ffd9 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_boolean_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_boolean_field_stats.ts @@ -14,11 +14,9 @@ import type { ISearchOptions, ISearchStart, } from '@kbn/data-plugin/public'; -import { - buildSamplerAggregation, - getSamplerAggregationsResponsePath, -} from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; +import { buildSamplerAggregation, getSamplerAggregationsResponsePath } from '@kbn/ml-agg-utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; + import type { Field, BooleanFieldStats, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_date_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_date_field_stats.ts index 705fe8c002319..1f55f8117c1be 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_date_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_date_field_stats.ts @@ -15,11 +15,8 @@ import type { ISearchOptions, ISearchStart, } from '@kbn/data-plugin/public'; -import { - buildSamplerAggregation, - getSamplerAggregationsResponsePath, -} from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; +import { buildSamplerAggregation, getSamplerAggregationsResponsePath } from '@kbn/ml-agg-utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { FieldStatsCommonRequestParams } from '../../../../../common/types/field_stats'; import type { Field, DateFieldStats, Aggs } from '../../../../../common/types/field_stats'; import { FieldStatsError, isIKibanaSearchResponse } from '../../../../../common/types/field_stats'; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_document_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_document_stats.ts index 6cd04de16fa6c..dd654e312e0ef 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_document_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_document_stats.ts @@ -7,8 +7,8 @@ import { each, get } from 'lodash'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { buildBaseFilterCriteria } from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; import type { DocumentCountStats, OverallStatsSearchStrategyParams, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_field_examples.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_field_examples.ts index 8b057caecee7c..0e04665256e20 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_field_examples.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_field_examples.ts @@ -14,8 +14,8 @@ import type { ISearchOptions, ISearchStart, } from '@kbn/data-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { buildBaseFilterCriteria } from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; import type { Field, FieldExamples, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts index 163cb2585f3a6..033f4469b0bc2 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts @@ -16,17 +16,14 @@ import { ISearchOptions, } from '@kbn/data-plugin/common'; import type { ISearchStart } from '@kbn/data-plugin/public'; +import { buildSamplerAggregation, getSamplerAggregationsResponsePath } from '@kbn/ml-agg-utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { MAX_PERCENT, PERCENTILE_SPACING, SAMPLER_TOP_TERMS_SHARD_SIZE, SAMPLER_TOP_TERMS_THRESHOLD, } from './constants'; -import { - buildSamplerAggregation, - getSamplerAggregationsResponsePath, -} from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; import type { Aggs, FieldStatsCommonRequestParams } from '../../../../../common/types/field_stats'; import type { Field, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_string_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_string_field_stats.ts index af4777a677bf9..60306ded5d8f4 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_string_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_string_field_stats.ts @@ -15,12 +15,9 @@ import type { ISearchOptions, ISearchStart, } from '@kbn/data-plugin/public'; +import { buildSamplerAggregation, getSamplerAggregationsResponsePath } from '@kbn/ml-agg-utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { SAMPLER_TOP_TERMS_SHARD_SIZE, SAMPLER_TOP_TERMS_THRESHOLD } from './constants'; -import { - buildSamplerAggregation, - getSamplerAggregationsResponsePath, -} from '../../../../../common/utils/query_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; import type { Aggs, Bucket, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts index 6a25fac65efe5..a25b3974d45b0 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts @@ -9,14 +9,13 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { get } from 'lodash'; import { Query } from '@kbn/es-query'; import { IKibanaSearchResponse } from '@kbn/data-plugin/common'; +import { buildSamplerAggregation, getSamplerAggregationsResponsePath } from '@kbn/ml-agg-utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { buildBaseFilterCriteria, - buildSamplerAggregation, getSafeAggregationName, - getSamplerAggregationsResponsePath, } from '../../../../../common/utils/query_utils'; import { getDatafeedAggregations } from '../../../../../common/utils/datafeed_utils'; -import { isPopulatedObject } from '../../../../../common/utils/object_utils'; import { AggregatableField, NonAggregatableField } from '../../types/overall_stats'; import { AggCardinality, Aggs } from '../../../../../common/types/field_stats'; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/error_utils.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/error_utils.ts index d89a9aca112b3..e8992764a7f97 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/error_utils.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/error_utils.ts @@ -7,7 +7,7 @@ import { HttpFetchError } from '@kbn/core/public'; import Boom from '@hapi/boom'; -import { isPopulatedObject } from '../../../../common/utils/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export interface WrappedError { body: { diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/query_utils.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/query_utils.ts index 43c5d49d1986f..5ceda44fa44b3 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/query_utils.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/query_utils.ts @@ -7,7 +7,7 @@ import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; import { cloneDeep } from 'lodash'; -import { isPopulatedObject } from '../../../../common/utils/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export const addExcludeFrozenToQuery = (originalQuery: QueryDslQueryContainer | undefined) => { const FROZEN_TIER_TERM = { diff --git a/x-pack/plugins/enterprise_search/KEA.md b/x-pack/plugins/enterprise_search/KEA.md index 17ae7cf71f833..368dc7d13ea73 100644 --- a/x-pack/plugins/enterprise_search/KEA.md +++ b/x-pack/plugins/enterprise_search/KEA.md @@ -26,99 +26,42 @@ Slicing up components into smaller chunks, designing clear interfaces for those State management tools are most powerful when used to coordinate state across an entire application, or large slices of that application. To do that well, state needs to be shared and it needs to be clear where in the existing state to find what information. We do this by separating API data from component data. -This means API interactions and their data should live in their own logic files, and the resulting data and API status should be imported by other logic files or directly by components consuming that data. Those API logic files should contain all interactions with APIs, and the current status of those API requests. Our idiomatic way of doing this follows: +This means API interactions and their data should live in their own logic files, and the resulting data and API status should be imported by other logic files or directly by components consuming that data. Those API logic files should contain all interactions with APIs, and the current status of those API requests. We have a util function to help you create those, located in [create_api_logic.ts](public/applications/shared/api_logic/create_api_logic.ts). You can grab the `status`, `data` and `error` values from any API created with that util. And you can listen to the `initiateCall`, `apiSuccess`, `apiError` and `apiReset` actions in other listeners. -```typescript -import { kea, MakeLogicType } from 'kea'; - -import { ApiStatus, HttpError } from '../../../../../../../../common/types/api'; -import { flashAPIErrors, clearFlashMessages } from '../../../../../../shared/flash_messages'; -import { HttpLogic } from '../../../../../../shared/http'; +You will need to provide a function that actually makes the api call, as well as the logic path. The function will need to accept and return a single object, not separate values. -export interface AddCustomSourceActions { - fetchSource(): void; - fetchSourceError(code: number, error: string): HttpError; - fetchSourceSuccess(source: CustomSource): CustomSource; -} - -interface CustomSource { +```typescript +export const addCustomSource = async ({ + name, + baseServiceType, +}: { name: string; -} - -interface AddCustomSourceValues { - sourceApiStatus: ApiStatus; -} - -export const AddCustomSourceLogic = kea< - MakeLogicType ->({ - path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], - actions: { - fetchSource: true, - fetchSourceError: (code, error) => ({ code, error }), - fetchSourceSuccess: (customSource) => customSource, - }, - reducers: () => ({ - sourceApiStatus: [ - { - status: 'IDLE', - }, - { - fetchSource: () => ({ - status: 'PENDING', - }), - fetchSourceError: (_, error) => ({ - status: 'ERROR', - error, - }), - fetchSourceSuccess: (_, data) => ({ - status: 'SUCCESS', - data, - }), - }, - ], - }), - listeners: ({ actions }) => ({ - fetchSource: async () => { - clearFlashMessages(); - - try { - const response = await HttpLogic.values.http.post('/api/source'); - actions.fetchSourceSuccess(response); - } catch (e) { - flashAPIErrors(e); - actions.fetchSourceError(e.code, e.message); - } - }, - }), -}); + baseServiceType?: string; +}) => { + const { isOrganization } = AppLogic.values; + const route = isOrganization + ? '/internal/workplace_search/org/create_source' + : '/internal/workplace_search/account/create_source'; + + const params = { + service_type: 'custom', + name, + base_service_type: baseServiceType, + }; + const source = await HttpLogic.values.http.post(route, { + body: JSON.stringify(params), + }); + return { source }; +}; + +export const AddCustomSourceApiLogic = createApiLogic( + ['add_custom_source_api_logic'], + addCustomSource +); ``` -The types used above can be found in our [common Enterprise Search types file](common/types/api.ts). While the above assumes a single, idempotent API, this approach can be easily extended to use a dictionary approach: -```typescript -reducers: () => ({ - sourceApiStatus: [ - { - }, - { - fetchSource: (state, id) => ({...state, - id: { - status: 'PENDING', - data: state[id]?.data, - }}), - fetchSourceError: (_, ({id, error})) => ({...state, - id: { - status: 'ERROR', - error, - }}), - fetchSourceSuccess: (_, ({id, data})) => ({...state, id: { - status: 'SUCCESS', - data, - }}), - }, - ], - }), -``` +The types used in that util can be found in our [common Enterprise Search types file](common/types/api.ts). + ## Import actions and values from API logic files into component and view logic. Once you have an API interactions file set up, components and other Kea logic files can import the values from those files to build their own logic. Use the Kea 'connect' functionality to do this, as the auto-connect functionality has a few bugs and was removed in Kea 3.0. This allows you to read the status and value of an API, react to any API events, and abstract those APIs away from the components. Those components can now become more functional and reactive to the current state of the application, rather than to directly responding to API events. @@ -130,34 +73,19 @@ export const AddCustomSourceLogic = kea< MakeLogicType >({ connect: { - actions: [AddCustomSourceApiLogic, ['addSource', 'addSourceSuccess', 'addSourceError']], - values: [AddCustomSourceApiLogic, ['sourceApi']], + actions: [AddCustomSourceApiLogic, ['initiateCall', 'apiSuccess', ]], + values: [AddCustomSourceApiLogic, ['status']], }, path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], actions: { createContentSource: true, - setCustomSourceNameValue: (customSourceNameValue) => customSourceNameValue, setNewCustomSource: (data) => data, }, - reducers: ({ props }) => ({ - customSourceNameValue: [ - props.initialValue || '', - { - setCustomSourceNameValue: (_, customSourceNameValue) => customSourceNameValue, - }, - ], - newCustomSource: [ - undefined, - { - setNewCustomSource: (_, newCustomSource) => newCustomSource, - }, - ], - }), listeners: ({ actions, values, props }) => ({ createContentSource: () => { const { customSourceNameValue } = values; const { baseServiceType } = props; - actions.addSource(customSourceNameValue, baseServiceType); + actions.initiateCall({ source: customSourceNameValue, baseServiceType }); }, addSourceSuccess: (customSource: CustomSource) => { actions.setNewCustomSource(customSource); @@ -165,20 +93,14 @@ export const AddCustomSourceLogic = kea< }), selectors: { buttonLoading: [ - (selectors) => [selectors.sourceApi], - (apiStatus) => apiStatus?.status === 'PENDING', + (selectors) => [selectors.status], + (apiStatus) => status === 'LOADING', ], }, }); ``` -You'll have to add the imported the actions and values types you're already using for your function, preferably by importing the types off the imported logic. Like so: -```typescript -export interface AddCustomSourceActions { - addSource: AddCustomSourceApiActions['addSource']; - addSourceSuccess: AddCustomSourceApiActions['addSourceSuccess']; -} -``` +You'll have to add the imported the actions and values types you're already using for your function, preferably by importing the types off the imported logic, so TypeScript can warn you if you're misusing the function. ## Keep your logic files small Using the above methods, you can keep your logic files small and isolated. Keep API calls separate from view and component logic. Keep the amount of logic you're processing limited per file. If your logic file starts exceeding about 150 lines of code, you should start thinking about splitting it up into separate chunks, if possible. diff --git a/x-pack/plugins/enterprise_search/common/types/api.ts b/x-pack/plugins/enterprise_search/common/types/api.ts index 2ba225bd19223..579f9535c7e4b 100644 --- a/x-pack/plugins/enterprise_search/common/types/api.ts +++ b/x-pack/plugins/enterprise_search/common/types/api.ts @@ -5,36 +5,53 @@ * 2.0. */ +import { HttpResponse } from '@kbn/core/public'; + /** * These types track an API call's status and result * Each Status string corresponds to a possible status in a request's lifecycle */ -export type Status = 'IDLE' | 'PENDING' | 'SUCCESS' | 'ERROR'; +export const enum Status { + IDLE, + LOADING, + SUCCESS, + ERROR, +} -export interface HttpError { - code: number; - message?: string; +export interface ErrorResponse { + statusCode: number; + error: string; + message: string; + attributes: { + errors: string[]; + }; } +export type HttpError = HttpResponse; + export interface ApiSuccess { - status: 'SUCCESS'; + status: Status.SUCCESS; data: T; + error?: undefined; } export interface ApiPending { - status: 'PENDING'; + status: Status.LOADING; data?: T; + error?: undefined; } export interface ApiIdle { - status: 'IDLE'; + status: Status.IDLE; data?: T; + error?: undefined; } export interface ApiError { - status: Status; + status: Status.ERROR; error: HttpError; + data?: undefined; } export type ApiStatus = ApiSuccess | ApiPending | ApiIdle | ApiError; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/shared_columns.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/shared_columns.tsx index e7c98332ee651..b4ddf18b8adb0 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/shared_columns.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/shared_columns.tsx @@ -86,9 +86,9 @@ export const ACTIONS_COLUMN = { try { const query = (item as Query).key || (item as RecentQuery).query_string || '""'; - const response = await http.get<{ id: string }>( + const response = await http.post<{ id: string }>( `/internal/app_search/engines/${engineName}/curations/find_or_create`, - { query: { query } } + { body: JSON.stringify({ query }) } ); navigateToUrl(generateEnginePath(ENGINE_CURATION_PATH, { curationId: response.id })); } catch (e) { diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx index d9ffb83a561c4..3033c1dcbeea0 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx @@ -44,35 +44,35 @@ export const runActionColumnTests = (wrapper: ReactWrapper) => { describe('edit action', () => { it('calls the find_or_create curation API, then navigates the user to the curation', async () => { - http.get.mockReturnValue(Promise.resolve({ id: 'cur-123456789' })); + http.post.mockReturnValue(Promise.resolve({ id: 'cur-123456789' })); wrapper.find('[data-test-subj="AnalyticsTableEditQueryButton"]').first().simulate('click'); await nextTick(); - expect(http.get).toHaveBeenCalledWith( + expect(http.post).toHaveBeenCalledWith( '/internal/app_search/engines/some-engine/curations/find_or_create', { - query: { query: 'some search' }, + body: JSON.stringify({ query: 'some search' }), } ); expect(navigateToUrl).toHaveBeenCalledWith('/engines/some-engine/curations/cur-123456789'); }); it('falls back to "" for the empty query', async () => { - http.get.mockReturnValue(Promise.resolve({ id: 'cur-987654321' })); + http.post.mockReturnValue(Promise.resolve({ id: 'cur-987654321' })); wrapper.find('[data-test-subj="AnalyticsTableEditQueryButton"]').last().simulate('click'); await nextTick(); - expect(http.get).toHaveBeenCalledWith( + expect(http.post).toHaveBeenCalledWith( '/internal/app_search/engines/some-engine/curations/find_or_create', { - query: { query: '""' }, + body: JSON.stringify({ query: '""' }), } ); expect(navigateToUrl).toHaveBeenCalledWith('/engines/some-engine/curations/cur-987654321'); }); it('handles API errors', async () => { - http.get.mockReturnValue(Promise.reject()); + http.post.mockReturnValue(Promise.reject()); wrapper.find('[data-test-subj="AnalyticsTableEditQueryButton"]').first().simulate('click'); await nextTick(); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/search_index_selectable.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/search_index_selectable.test.tsx index 4adaf4050ffe5..74836d6e0e202 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/search_index_selectable.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine_creation/search_index_selectable.test.tsx @@ -8,7 +8,7 @@ import '../../../__mocks__/shallow_useeffect.mock'; import { setMockActions, setMockValues } from '../../../__mocks__/kea_logic'; -import React from 'react'; +import React, { MouseEvent } from 'react'; import { shallow, mount } from 'enzyme'; @@ -121,7 +121,10 @@ describe('SearchIndexSelectable', () => { it('calls setSelectedIndex onChange', () => { const wrapper = shallow(); const onChangeHandler = wrapper.find(EuiSelectable).prop('onChange')!; - onChangeHandler(DEFAULT_VALUES.indicesFormatted as SearchIndexSelectableOption[]); + onChangeHandler( + DEFAULT_VALUES.indicesFormatted as SearchIndexSelectableOption[], + {} as MouseEvent + ); expect(MOCK_ACTIONS.setSelectedIndex).toHaveBeenCalledWith('search-test-index-2'); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx new file mode 100644 index 0000000000000..f47be4269edcc --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.test.tsx @@ -0,0 +1,26 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { shallow } from 'enzyme'; + +import { MethodApi } from './method_api'; +import { NewSearchIndexTemplate } from './new_search_index_template'; + +describe('API ingestion method', () => { + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('renders API ingestion method tab', () => { + const wrapper = shallow(); + const template = wrapper.find(NewSearchIndexTemplate); + + expect(template.prop('type')).toEqual('api'); + }); +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx index 699b84327978c..a68c33db0eae5 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_api.tsx @@ -8,76 +8,34 @@ /** * TODO: * - Need to add documentation URLs (search for `#`s) - * - Need to implement the logic for the attaching search engines functionality */ import React from 'react'; -import { useValues } from 'kea'; - -import { EuiCodeBlock, EuiLink, EuiPanel, EuiSpacer, EuiText, EuiTitle } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; +import { EuiText } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { getEnterpriseSearchUrl } from '../../../shared/enterprise_search_url/external_url'; - -import { DOCUMENTS_API_JSON_EXAMPLE } from './constants'; -import { NewSearchIndexLogic } from './new_search_index_logic'; import { NewSearchIndexTemplate } from './new_search_index_template'; export const MethodApi: React.FC = () => { - const { name } = useValues(NewSearchIndexLogic); - const apiKey = 1212312313; // TODO change this - - const searchIndexApiUrl = getEnterpriseSearchUrl('/api/ent/v1/search_indices/'); - return ( + } description={ - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.methodApi.description.clientLibrariesLink', - { - defaultMessage: 'client libraries', - } - )} - - ), - }} + defaultMessage="Provide a name and optionally select a language analyzer for your documents. An Elasticsearch index will be created. In the next step, well display API instructions." /> } docsUrl="#" type="api" - > - - -

- {i18n.translate('xpack.enterpriseSearch.content.newIndex.methodApi.endpointTitle', { - defaultMessage: 'Enter a name to preview your new API endpoint', - })} -

- - {name && ( - <> - - - {`\ -curl -X POST '${searchIndexApiUrl}${name}/document' \\ - -H 'Content-Type: application/json' \\ - -H 'Authorization: Bearer ${apiKey}' \\ - -d '${JSON.stringify(DOCUMENTS_API_JSON_EXAMPLE, null, 2)}' -`} - - - )} - - + /> ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx index 927f5e79ff2ff..36522002d7e88 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/method_connector.tsx @@ -21,6 +21,7 @@ import { NewSearchIndexTemplate } from './new_search_index_template'; export const MethodConnector: React.FC = () => { return ( { return ( { return ( { return ( { id: 'crawler', icon: 'globe', label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.crawler.label', { - defaultMessage: 'Web crawler', + defaultMessage: 'Use the web crawler', }), description: i18n.translate( 'xpack.enterpriseSearch.content.newIndex.buttonGroup.crawler.description', { - defaultMessage: 'Automatically index content from your website or knowlege base', - } - ), - }, - { - id: 'api', - icon: 'visVega', - label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.api.label', { - defaultMessage: 'API', - }), - description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.api.description', - { - defaultMessage: 'Use a variety of client libraries to add documents to your search index', + defaultMessage: 'Index content from your websites', } ), }, @@ -93,42 +74,42 @@ export const NewIndex: React.FC = () => { id: 'connector', icon: 'package', label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.connector.label', { - defaultMessage: 'Connector', + defaultMessage: 'Use a data integration', }), description: i18n.translate( 'xpack.enterpriseSearch.content.newIndex.buttonGroup.connector.description', { defaultMessage: - 'Ingest data from content sources like GitHub, Google Drive or SharePoint', + 'Index content frrom third-party services such as SharePoint and Google Drive', } ), }, { - id: 'elasticsearch', - icon: 'logoElasticsearch', - label: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.elasticsearch.label', - { - defaultMessage: 'Elasticsearch index', - } - ), + id: 'api', + icon: 'visVega', + label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.api.label', { + defaultMessage: 'Use the API', + }), description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.elasticsearch.description', + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.api.description', { - defaultMessage: 'Connect to an existing Elasticsearch index', + defaultMessage: 'Use a variety of client libraries to add documents to your search index', } ), }, { - id: 'json', - icon: 'document', - label: i18n.translate('xpack.enterpriseSearch.content.newIndex.buttonGroup.json.label', { - defaultMessage: 'Paste or upload JSON', - }), + id: 'customIntegration', + icon: 'package', + label: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.customIntegration.label', + { + defaultMessage: 'Build a custom data integration', + } + ), description: i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.buttonGroup.json.description', + 'xpack.enterpriseSearch.content.newIndex.buttonGroup.customIntegration.description', { - defaultMessage: 'Manually upload JSON files', + defaultMessage: 'Clone the connector package repo and start customizing.', } ), }, @@ -150,37 +131,20 @@ export const NewIndex: React.FC = () => { ); - const CardLabel: React.FC = ({ title, description, icon }) => ( - - - - - - - -

{title}

- - - - - {description} - - ); - const SelectSearchIndexLayout = () => ( <> - - + +

{i18n.translate('xpack.enterpriseSearch.content.newIndex.selectSearchIndex.title', { - defaultMessage: 'Create a search index', + defaultMessage: 'Select an ingestion method', })}

- +

{i18n.translate( 'xpack.enterpriseSearch.content.newIndex.selectSearchIndex.description', @@ -195,32 +159,42 @@ export const NewIndex: React.FC = () => { {buttonGroupOptions.map((item) => ( - + handleMethodChange(item.id)} - checked={selectedMethod.id === item.id} - /> + hasShadow={false} + onClick={() => { + handleMethodChange(item.id); + }} + > + + + + + +

{item.label}

+ + + + +

{item.description}

+ + + + + +
+ +
+ + + ))} - - - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.selectSearchIndex.learnMore.buttonText', - { - defaultMessage: 'Learn more about search indices', - } - )} - diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts index 9c205274f9cf9..d12ab55a37f75 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.test.ts @@ -11,12 +11,9 @@ import { DEFAULT_LANGUAGE } from './constants'; import { NewSearchIndexLogic } from './new_search_index_logic'; const DEFAULT_VALUES = { - searchEngines: [], - searchEngineSelectOptions: [], rawName: '', name: '', language: DEFAULT_LANGUAGE, - selectedSearchEngines: [], }; describe('NewSearchIndexLogic', () => { diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts index b1626c90b3f59..f2034a8c4ce76 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_logic.ts @@ -7,43 +7,26 @@ import { kea, MakeLogicType } from 'kea'; -import type { EuiComboBoxOptionOption } from '@elastic/eui'; - -import { Engine } from '../../../app_search/components/engine/types'; import { formatApiName } from '../../utils/format_api_name'; -import { SearchIndicesLogic, SearchIndicesValues } from '../search_indices/search_indices_logic'; - import { DEFAULT_LANGUAGE } from './constants'; -import { ISearchEngineOption } from './new_search_index_template'; -export interface NewSearchIndexValues extends Pick { - searchEngineSelectOptions: ISearchEngineOption[]; +export interface NewSearchIndexValues { rawName: string; name: string; language: string; - selectedSearchEngines: Array>; } export interface NewSearchIndexActions { setRawName(rawName: string): { rawName: string }; setLanguage(language: string): { language: string }; - setSelectedSearchEngineOptions(selectedSearchEngines: Array>): { - selectedSearchEngines: Array>; - }; } export const NewSearchIndexLogic = kea>({ path: ['enterprise_search', 'content', 'new_search_index'], - connect: { - values: [SearchIndicesLogic, ['searchEngines']], - }, actions: { setRawName: (rawName) => ({ rawName }), setLanguage: (language) => ({ language }), - setSelectedSearchEngineOptions: (selectedSearchEngines) => ({ - selectedSearchEngines, - }), }, reducers: { language: [ @@ -58,22 +41,8 @@ export const NewSearchIndexLogic = kea rawName, }, ], - selectedSearchEngines: [ - [], - { - setSelectedSearchEngineOptions: (_, { selectedSearchEngines }) => selectedSearchEngines, - }, - ], }, selectors: ({ selectors }) => ({ name: [() => [selectors.rawName], (rawName) => formatApiName(rawName)], - searchEngineSelectOptions: [ - () => [selectors.searchEngines], - (searchEngines) => - searchEngines.map((s: Engine) => ({ - label: s.name, - value: s, - })), - ], }), }); diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx index b0e3adf3bdb71..1eb228aa876e0 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/new_index/new_search_index_template.tsx @@ -17,7 +17,6 @@ import { useValues, useActions } from 'kea'; import { EuiButton, - EuiComboBox, EuiFieldText, EuiFlexGroup, EuiFlexItem, @@ -26,6 +25,7 @@ import { EuiPanel, EuiSelect, EuiSpacer, + EuiSteps, EuiText, EuiTitle, } from '@elastic/eui'; @@ -33,10 +33,11 @@ import { i18n } from '@kbn/i18n'; import { Engine } from '../../../app_search/components/engine/types'; -import { SUPPORTED_LANGUAGES, NEW_INDEX_TEMPLATE_TYPES } from './constants'; +import { SUPPORTED_LANGUAGES } from './constants'; import { NewSearchIndexLogic } from './new_search_index_logic'; export interface ISearchIndex { + title: React.ReactNode; description: React.ReactNode; docsUrl: string; type: string; @@ -50,14 +51,12 @@ export interface ISearchEngineOption { export const NewSearchIndexTemplate: React.FC = ({ children, + title, description, - type, onNameChange, }) => { - const { searchEngineSelectOptions, name, language, rawName, selectedSearchEngines } = - useValues(NewSearchIndexLogic); - const { setRawName, setLanguage, setSelectedSearchEngineOptions } = - useActions(NewSearchIndexLogic); + const { name, language, rawName } = useValues(NewSearchIndexLogic); + const { setRawName, setLanguage } = useActions(NewSearchIndexLogic); const handleNameChange = (e: ChangeEvent) => { setRawName(e.target.value); @@ -75,15 +74,7 @@ export const NewSearchIndexTemplate: React.FC = ({ -

- {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.title', - { - defaultMessage: 'New {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, - } - )} -

+

{title}

@@ -106,8 +97,17 @@ export const NewSearchIndexTemplate: React.FC = ({ label={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputLabel', { - defaultMessage: 'Name your {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, + defaultMessage: 'Index name', + } + )} + helpText={i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputHelpText', + { + defaultMessage: + 'Names cannot contain spaces or special characters. {indexName}', + values: { + indexName: name.length > 0 ? `Your index will be named: ${name}` : '', + }, } )} fullWidth @@ -116,8 +116,7 @@ export const NewSearchIndexTemplate: React.FC = ({ placeholder={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.nameInputPlaceholder', { - defaultMessage: 'Set a name for the {type}', - values: { type: NEW_INDEX_TEMPLATE_TYPES[type] }, + defaultMessage: 'Set a name for your index', } )} fullWidth @@ -132,7 +131,13 @@ export const NewSearchIndexTemplate: React.FC = ({ label={i18n.translate( 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.languageInputLabel', { - defaultMessage: 'Language', + defaultMessage: 'Document language', + } + )} + helpText={i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.languageInputHelpText', + { + defaultMessage: 'Analyzers can be changed later, but may require a reindex', } )} > @@ -145,48 +150,107 @@ export const NewSearchIndexTemplate: React.FC = ({ - {searchEngineSelectOptions.length !== 0 && ( - - - { - setSelectedSearchEngineOptions(options); - }} - selectedOptions={selectedSearchEngines} - /> - - - )} {children} - - - {i18n.translate( - 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.createIndex.buttonText', - { - defaultMessage: 'Create search index', - } - )} - - + + + + {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.createIndex.buttonText', + { + defaultMessage: 'Create index', + } + )} + + + + + {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.viewDocumentation.linkText', + { + defaultMessage: 'View the documentation', + } + )} + + + + + + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.createIndex.content', + { + defaultMessage: + 'Provide a unique name for your index and select an optional language analyzer.', + } + )} +

+ + ), + status: 'incomplete', + }, + { + title: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.configureIngestion.title', + { + defaultMessage: 'Configure ingestion settings', + } + ), + titleSize: 'xs', + children: ( + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.configureIngestion.content', + { + defaultMessage: + 'Generate an API key and view the documentation for posting documents to the Elasticsearch API endpoint. Language clients are available for streamlined integration.', + } + )} +

+ + ), + status: 'incomplete', + }, + { + title: i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.buildSearchExperience.title', + { + defaultMessage: 'Build a search experience', + } + ), + titleSize: 'xs', + children: ( + +

+ {i18n.translate( + 'xpack.enterpriseSearch.content.newIndex.newSearchIndexTemplate.steps.buildSearchExperience.content', + { + defaultMessage: + 'Connect your newly created Elasticsearch index to an App Search engine to build a cusomtizable search experience.', + } + )} +

+ + ), + status: 'incomplete', + }, + ]} + /> ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.test.ts new file mode 100644 index 0000000000000..3687ccbde7723 --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.test.ts @@ -0,0 +1,130 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { LogicMounter } from '../../__mocks__/kea_logic'; + +import { nextTick } from '@kbn/test-jest-helpers'; + +import { HttpError, Status } from '../../../../common/types/api'; + +import { createApiLogic } from './create_api_logic'; + +const DEFAULT_VALUES = { + apiStatus: { + status: Status.IDLE, + }, + data: undefined, + error: undefined, + status: Status.IDLE, +}; + +describe('CreateApiLogic', () => { + const apiCallMock = jest.fn(); + const logic = createApiLogic(['path'], apiCallMock); + const { mount } = new LogicMounter(logic); + + beforeEach(() => { + jest.clearAllMocks(); + mount({}); + }); + + it('has expected default values', () => { + expect(logic.values).toEqual(DEFAULT_VALUES); + }); + + describe('actions', () => { + describe('makeRequest', () => { + it('should set status to LOADING', () => { + logic.actions.makeRequest({}); + expect(logic.values).toEqual({ + ...DEFAULT_VALUES, + status: Status.LOADING, + apiStatus: { + status: Status.LOADING, + }, + }); + }); + }); + describe('apiSuccess', () => { + it('should set status to SUCCESS and load data', () => { + logic.actions.apiSuccess({ success: 'data' }); + expect(logic.values).toEqual({ + ...DEFAULT_VALUES, + status: Status.SUCCESS, + data: { success: 'data' }, + apiStatus: { + status: Status.SUCCESS, + data: { success: 'data' }, + }, + }); + }); + }); + describe('apiError', () => { + it('should set status to ERROR and set error data', () => { + logic.actions.apiError('error' as any as HttpError); + expect(logic.values).toEqual({ + ...DEFAULT_VALUES, + status: Status.ERROR, + data: undefined, + error: 'error', + apiStatus: { + status: Status.ERROR, + data: undefined, + error: 'error', + }, + }); + }); + }); + describe('apiReset', () => { + it('should reset api', () => { + logic.actions.apiError('error' as any as HttpError); + expect(logic.values).toEqual({ + ...DEFAULT_VALUES, + status: Status.ERROR, + data: undefined, + error: 'error', + apiStatus: { + status: Status.ERROR, + data: undefined, + error: 'error', + }, + }); + logic.actions.apiReset(); + expect(logic.values).toEqual(DEFAULT_VALUES); + }); + }); + }); + + describe('listeners', () => { + describe('makeRequest', () => { + it('calls apiCall on success', async () => { + const apiSuccessMock = jest.spyOn(logic.actions, 'apiSuccess'); + const apiErrorMock = jest.spyOn(logic.actions, 'apiError'); + apiCallMock.mockReturnValue(Promise.resolve('result')); + logic.actions.makeRequest({ arg: 'argument1' }); + expect(apiCallMock).toHaveBeenCalledWith({ arg: 'argument1' }); + await nextTick(); + expect(apiErrorMock).not.toHaveBeenCalled(); + expect(apiSuccessMock).toHaveBeenCalledWith('result'); + }); + it('calls apiError on error', async () => { + const apiSuccessMock = jest.spyOn(logic.actions, 'apiSuccess'); + const apiErrorMock = jest.spyOn(logic.actions, 'apiError'); + apiCallMock.mockReturnValue( + Promise.reject({ body: { statusCode: 404, message: 'message' } }) + ); + logic.actions.makeRequest({ arg: 'argument1' }); + expect(apiCallMock).toHaveBeenCalledWith({ arg: 'argument1' }); + await nextTick(); + expect(apiSuccessMock).not.toHaveBeenCalled(); + expect(apiErrorMock).toHaveBeenCalledWith({ + body: { statusCode: 404, message: 'message' }, + }); + }); + }); + }); +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.ts b/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.ts new file mode 100644 index 0000000000000..57a8d3751a6ac --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/shared/api_logic/create_api_logic.ts @@ -0,0 +1,76 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { kea, MakeLogicType } from 'kea'; + +import { ApiStatus, Status, HttpError } from '../../../../common/types/api'; + +export interface Values { + apiStatus: ApiStatus; + status: Status; + data?: T; + error: HttpError; +} + +export interface Actions | undefined, Result> { + makeRequest(args: Args): Args; + apiError(error: HttpError): HttpError; + apiSuccess(result: Result): Result; + apiReset(): void; +} + +export const createApiLogic = | undefined>( + path: string[], + apiFunction: (args: Args) => Promise +) => + kea, Actions>>({ + path: ['enterprise_search', ...path], + actions: { + makeRequest: (args) => args, + apiError: (error) => error, + apiSuccess: (result) => result, + apiReset: true, + }, + reducers: () => ({ + apiStatus: [ + { + status: Status.IDLE, + }, + { + makeRequest: () => ({ + status: Status.LOADING, + }), + apiError: (_, error) => ({ + status: Status.ERROR, + error, + }), + apiSuccess: (_, data) => ({ + status: Status.SUCCESS, + data, + }), + apiReset: () => ({ + status: Status.IDLE, + }), + }, + ], + }), + listeners: ({ actions }) => ({ + makeRequest: async (args) => { + try { + const result = await apiFunction(args); + actions.apiSuccess(result); + } catch (e) { + actions.apiError(e); + } + }, + }), + selectors: ({ selectors }) => ({ + status: [() => [selectors.apiStatus], (apiStatus: ApiStatus) => apiStatus.status], + data: [() => [selectors.apiStatus], (apiStatus: ApiStatus) => apiStatus.data], + error: [() => [selectors.apiStatus], (apiStatus: ApiStatus) => apiStatus.error], + }), + }); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts index a08d024e465ad..3f95f5058b0c2 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.test.ts @@ -5,151 +5,45 @@ * 2.0. */ -import { - LogicMounter, - mockFlashMessageHelpers, - mockHttpValues, -} from '../../../../../../__mocks__/kea_logic'; -import { sourceConfigData } from '../../../../../__mocks__/content_sources.mock'; +import { mockHttpValues } from '../../../../../../__mocks__/kea_logic'; import { nextTick } from '@kbn/test-jest-helpers'; -import { itShowsServerErrorAsFlashMessage } from '../../../../../../test_helpers'; - jest.mock('../../../../../app_logic', () => ({ AppLogic: { values: { isOrganization: true } }, })); import { AppLogic } from '../../../../../app_logic'; -import { AddCustomSourceApiLogic } from './add_custom_source_api_logic'; - -const DEFAULT_VALUES = { - sourceApi: { - status: 'IDLE', - }, -}; - -const MOCK_NAME = 'name'; +import { addCustomSource } from './add_custom_source_api_logic'; -describe('AddCustomSourceLogic', () => { - const { mount } = new LogicMounter(AddCustomSourceApiLogic); +describe('addCustomSource', () => { const { http } = mockHttpValues; - const { clearFlashMessages } = mockFlashMessageHelpers; beforeEach(() => { jest.clearAllMocks(); - mount({}); }); - it('has expected default values', () => { - expect(AddCustomSourceApiLogic.values).toEqual(DEFAULT_VALUES); - }); - - describe('listeners', () => { - beforeEach(() => { - mount(); - }); - - describe('organization context', () => { - describe('createContentSource', () => { - it('calls API and sets values', async () => { - const addSourceSuccessSpy = jest.spyOn( - AddCustomSourceApiLogic.actions, - 'addSourceSuccess' - ); - http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); - - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); - - expect(clearFlashMessages).toHaveBeenCalled(); - expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { - body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), - }); - await nextTick(); - expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); - }); - - it('submits a base service type for pre-configured sources', async () => { - const addSourceSuccessSpy = jest.spyOn( - AddCustomSourceApiLogic.actions, - 'addSourceSuccess' - ); - http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); - - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME, 'base_service_type'); - - expect(clearFlashMessages).toHaveBeenCalled(); - expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { - body: JSON.stringify({ - service_type: 'custom', - name: MOCK_NAME, - base_service_type: 'base_service_type', - }), - }); - await nextTick(); - expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); - }); - - itShowsServerErrorAsFlashMessage(http.post, () => { - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); - }); - }); + it('calls correct route for organization', async () => { + const promise = Promise.resolve('result'); + http.post.mockReturnValue(promise); + addCustomSource({ name: 'name', baseServiceType: 'baseServiceType' }); + await nextTick(); + expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/org/create_source', { + body: JSON.stringify({ + service_type: 'custom', + name: 'name', + base_service_type: 'baseServiceType', + }), }); - - describe('account context routes', () => { - beforeEach(() => { - AppLogic.values.isOrganization = false; - }); - - describe('createContentSource', () => { - it('calls API and sets values', async () => { - const addSourceSuccessSpy = jest.spyOn( - AddCustomSourceApiLogic.actions, - 'addSourceSuccess' - ); - http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); - - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); - - expect(clearFlashMessages).toHaveBeenCalled(); - expect(http.post).toHaveBeenCalledWith( - '/internal/workplace_search/account/create_source', - { - body: JSON.stringify({ service_type: 'custom', name: MOCK_NAME }), - } - ); - await nextTick(); - expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); - }); - - it('submits a base service type for pre-configured sources', async () => { - const addSourceSuccessSpy = jest.spyOn( - AddCustomSourceApiLogic.actions, - 'addSourceSuccess' - ); - http.post.mockReturnValue(Promise.resolve({ sourceConfigData })); - - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME, 'base_service_type'); - - expect(clearFlashMessages).toHaveBeenCalled(); - expect(http.post).toHaveBeenCalledWith( - '/internal/workplace_search/account/create_source', - { - body: JSON.stringify({ - service_type: 'custom', - name: MOCK_NAME, - base_service_type: 'base_service_type', - }), - } - ); - await nextTick(); - expect(addSourceSuccessSpy).toHaveBeenCalledWith({ sourceConfigData }); - }); - - itShowsServerErrorAsFlashMessage(http.post, () => { - AddCustomSourceApiLogic.actions.addSource(MOCK_NAME); - }); - }); + }); + it('calls correct route for account', async () => { + const promise = Promise.resolve('result'); + AppLogic.values.isOrganization = false; + http.post.mockReturnValue(promise); + addCustomSource({ name: 'name' }); + await nextTick(); + expect(http.post).toHaveBeenCalledWith('/internal/workplace_search/account/create_source', { + body: JSON.stringify({ service_type: 'custom', name: 'name' }), }); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts index 4c4655a3882e0..a3e1afe4cdd11 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_api_logic.ts @@ -5,76 +5,35 @@ * 2.0. */ -import { kea, MakeLogicType } from 'kea'; - -import { ApiStatus, HttpError } from '../../../../../../../../common/types/api'; -import { flashAPIErrors, clearFlashMessages } from '../../../../../../shared/flash_messages'; +import { createApiLogic } from '../../../../../../shared/api_logic/create_api_logic'; import { HttpLogic } from '../../../../../../shared/http'; import { AppLogic } from '../../../../../app_logic'; import { CustomSource } from '../../../../../types'; -export interface AddCustomSourceApiActions { - addSource(name: string, baseServiceType?: string): { name: string; baseServiceType: string }; - addSourceError(code: number, error: string): HttpError; - addSourceSuccess(source: CustomSource): { source: CustomSource }; -} - -export interface AddCustomSourceApiValues { - sourceApi: ApiStatus; -} - -export const AddCustomSourceApiLogic = kea< - MakeLogicType ->({ - path: ['enterprise_search', 'workplace_search', 'add_custom_source_api_logic'], - actions: { - addSource: (name, baseServiceType) => ({ name, baseServiceType }), - addSourceError: (code, error) => ({ code, error }), - addSourceSuccess: (customSource) => ({ source: customSource }), - }, - reducers: () => ({ - sourceApi: [ - { - status: 'IDLE', - }, - { - addSource: () => ({ - status: 'PENDING', - }), - addSourceError: (_, error) => ({ - status: 'ERROR', - error, - }), - addSourceSuccess: (_, { source }) => ({ - status: 'SUCCESS', - data: source, - }), - }, - ], - }), - listeners: ({ actions }) => ({ - addSource: async ({ name, baseServiceType }) => { - clearFlashMessages(); - const { isOrganization } = AppLogic.values; - const route = isOrganization - ? '/internal/workplace_search/org/create_source' - : '/internal/workplace_search/account/create_source'; +export const addCustomSource = async ({ + name, + baseServiceType, +}: { + name: string; + baseServiceType?: string; +}) => { + const { isOrganization } = AppLogic.values; + const route = isOrganization + ? '/internal/workplace_search/org/create_source' + : '/internal/workplace_search/account/create_source'; - const params = { - service_type: 'custom', - name, - base_service_type: baseServiceType, - }; + const params = { + service_type: 'custom', + name, + base_service_type: baseServiceType, + }; + const source = await HttpLogic.values.http.post(route, { + body: JSON.stringify(params), + }); + return { source }; +}; - try { - const response = await HttpLogic.values.http.post(route, { - body: JSON.stringify(params), - }); - actions.addSourceSuccess(response); - } catch (e) { - flashAPIErrors(e); - actions.addSourceError(e?.body?.statusCode, e?.body?.message); - } - }, - }), -}); +export const AddCustomSourceApiLogic = createApiLogic( + ['workplace_search', 'add_custom_source_api_logic'], + addCustomSource +); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts index 59825c0bd386c..d62530454f7f7 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.test.ts @@ -7,12 +7,17 @@ import { LogicMounter } from '../../../../../../__mocks__/kea_logic'; +import { mockFlashMessageHelpers } from '../../../../../../__mocks__/kea_logic'; + +import { Status } from '../../../../../../../../common/types/api'; + jest.mock('../../../../../app_logic', () => ({ AppLogic: { values: { isOrganization: true } }, })); import { CustomSource } from '../../../../../types'; +import { AddCustomSourceApiLogic } from './add_custom_source_api_logic'; import { AddCustomSourceLogic, AddCustomSourceSteps } from './add_custom_source_logic'; const DEFAULT_VALUES = { @@ -20,15 +25,14 @@ const DEFAULT_VALUES = { buttonLoading: false, customSourceNameValue: '', newCustomSource: {} as CustomSource, - sourceApi: { - status: 'IDLE', - }, + status: Status.IDLE, }; const MOCK_NAME = 'name'; describe('AddCustomSourceLogic', () => { const { mount } = new LogicMounter(AddCustomSourceLogic); + const { clearFlashMessages, flashAPIErrors } = mockFlashMessageHelpers; beforeEach(() => { jest.clearAllMocks(); @@ -40,27 +44,48 @@ describe('AddCustomSourceLogic', () => { }); describe('actions', () => { - describe('addSourceSuccess', () => { + describe('apiSuccess', () => { it('sets a new source', () => { - const customSource: CustomSource = { + AddCustomSourceLogic.actions.makeRequest({ name: 'name' }); + const source: CustomSource = { accessToken: 'a', name: 'b', id: '1', }; - AddCustomSourceLogic.actions.addSourceSuccess(customSource); + AddCustomSourceLogic.actions.apiSuccess({ source }); expect(AddCustomSourceLogic.values).toEqual({ ...DEFAULT_VALUES, customSourceNameValue: '', - newCustomSource: customSource, - sourceApi: { - status: 'SUCCESS', - data: customSource, - }, + newCustomSource: source, + status: Status.SUCCESS, currentStep: AddCustomSourceSteps.SaveCustomStep, }); }); }); + describe('makeRequest', () => { + it('sets button to loading', () => { + AddCustomSourceLogic.actions.makeRequest({ name: 'name' }); + + expect(AddCustomSourceLogic.values).toEqual({ + ...DEFAULT_VALUES, + buttonLoading: true, + status: Status.LOADING, + }); + }); + }); + describe('apiError', () => { + it('sets button to not loading', () => { + AddCustomSourceLogic.actions.makeRequest({ name: 'name' }); + AddCustomSourceLogic.actions.apiError('error' as any); + + expect(AddCustomSourceLogic.values).toEqual({ + ...DEFAULT_VALUES, + buttonLoading: false, + status: Status.ERROR, + }); + }); + }); describe('setCustomSourceNameValue', () => { it('saves the name', () => { AddCustomSourceLogic.actions.setCustomSourceNameValue('name'); @@ -98,33 +123,48 @@ describe('AddCustomSourceLogic', () => { customSourceNameValue: MOCK_NAME, }); }); - - describe('organization context', () => { - describe('createContentSource', () => { - it('calls addSource on AddCustomSourceApi logic', async () => { - const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'addSource'); - - AddCustomSourceLogic.actions.createContentSource(); - expect(addSourceSpy).toHaveBeenCalledWith(MOCK_NAME, undefined); + describe('createContentSource', () => { + it('calls addSource on AddCustomSourceApi logic', async () => { + const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'makeRequest'); + + AddCustomSourceLogic.actions.createContentSource(); + expect(addSourceSpy).toHaveBeenCalledWith({ + name: MOCK_NAME, + baseServiceType: undefined, }); + }); - it('submits a base service type for pre-configured sources', () => { - mount( - { - customSourceNameValue: MOCK_NAME, - }, - { - baseServiceType: 'share_point_server', - } - ); + it('submits a base service type for pre-configured sources', () => { + mount( + { + customSourceNameValue: MOCK_NAME, + }, + { + baseServiceType: 'share_point_server', + } + ); - const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'addSource'); + const addSourceSpy = jest.spyOn(AddCustomSourceLogic.actions, 'makeRequest'); - AddCustomSourceLogic.actions.createContentSource(); + AddCustomSourceLogic.actions.createContentSource(); - expect(addSourceSpy).toHaveBeenCalledWith(MOCK_NAME, 'share_point_server'); + expect(addSourceSpy).toHaveBeenCalledWith({ + name: MOCK_NAME, + baseServiceType: 'share_point_server', }); }); }); + describe('makeRequest', () => { + it('should call clearFlashMessages', () => { + AddCustomSourceApiLogic.actions.makeRequest({ name: 'name' }); + expect(clearFlashMessages).toHaveBeenCalled(); + }); + }); + describe('apiError', () => { + it('should call flashAPIError', () => { + AddCustomSourceApiLogic.actions.apiError('error' as any); + expect(flashAPIErrors).toHaveBeenCalledWith('error'); + }); + }); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts index 76041744b3c37..0f81e78d98868 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_custom_source/add_custom_source_logic.ts @@ -7,13 +7,11 @@ import { kea, MakeLogicType } from 'kea'; +import { HttpError, Status } from '../../../../../../../../common/types/api'; +import { clearFlashMessages, flashAPIErrors } from '../../../../../../shared/flash_messages'; import { CustomSource } from '../../../../../types'; -import { - AddCustomSourceApiActions, - AddCustomSourceApiLogic, - AddCustomSourceApiValues, -} from './add_custom_source_api_logic'; +import { AddCustomSourceApiLogic } from './add_custom_source_api_logic'; export interface AddCustomSourceProps { baseServiceType?: string; @@ -26,8 +24,9 @@ export enum AddCustomSourceSteps { } export interface AddCustomSourceActions { - addSource: AddCustomSourceApiActions['addSource']; - addSourceSuccess: AddCustomSourceApiActions['addSourceSuccess']; + makeRequest: typeof AddCustomSourceApiLogic.actions.makeRequest; + apiSuccess({ source }: { source: CustomSource }): { source: CustomSource }; + apiError(error: HttpError): HttpError; createContentSource(): void; setCustomSourceNameValue(customSourceNameValue: string): string; setNewCustomSource(data: CustomSource): CustomSource; @@ -38,7 +37,7 @@ interface AddCustomSourceValues { currentStep: AddCustomSourceSteps; customSourceNameValue: string; newCustomSource: CustomSource; - sourceApi: AddCustomSourceApiValues['sourceApi']; + status: Status; } /** @@ -50,8 +49,8 @@ export const AddCustomSourceLogic = kea< MakeLogicType >({ connect: { - actions: [AddCustomSourceApiLogic, ['addSource', 'addSourceSuccess', 'addSourceError']], - values: [AddCustomSourceApiLogic, ['sourceApi']], + actions: [AddCustomSourceApiLogic, ['makeRequest', 'apiError', 'apiSuccess']], + values: [AddCustomSourceApiLogic, ['status']], }, path: ['enterprise_search', 'workplace_search', 'add_custom_source_logic'], actions: { @@ -64,8 +63,8 @@ export const AddCustomSourceLogic = kea< false, { createContentSource: () => true, - addSourceSuccess: () => false, - addSourceError: () => false, + apiSuccess: () => false, + apiError: () => false, }, ], currentStep: [ @@ -91,16 +90,15 @@ export const AddCustomSourceLogic = kea< createContentSource: () => { const { customSourceNameValue } = values; const { baseServiceType } = props; - actions.addSource(customSourceNameValue, baseServiceType); + actions.makeRequest({ name: customSourceNameValue, baseServiceType }); }, - addSourceSuccess: ({ source }) => { + makeRequest: () => clearFlashMessages(), + apiError: (error) => flashAPIErrors(error), + apiSuccess: ({ source }) => { actions.setNewCustomSource(source); }, }), selectors: { - buttonLoading: [ - (selectors) => [selectors.sourceApi], - (apiStatus) => apiStatus?.status === 'PENDING', - ], + buttonLoading: [(selectors) => [selectors.status], (status) => status === Status.LOADING], }, }); diff --git a/x-pack/plugins/enterprise_search/server/integrations.ts b/x-pack/plugins/enterprise_search/server/integrations.ts index 140e36ba15555..ec3a13f526528 100644 --- a/x-pack/plugins/enterprise_search/server/integrations.ts +++ b/x-pack/plugins/enterprise_search/server/integrations.ts @@ -175,7 +175,7 @@ const workplaceSearchIntegrations: WorkplaceSearchIntegration[] = [ } ), categories: ['enterprise_search', 'file_storage'], - uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/network_drive', + uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/network_drive/custom', }, { id: 'onedrive', @@ -203,7 +203,7 @@ const workplaceSearchIntegrations: WorkplaceSearchIntegration[] = [ } ), categories: ['enterprise_search', 'microsoft_365', 'communications', 'productivity'], - uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/outlook', + uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/outlook/custom', }, { id: 'salesforce', @@ -280,7 +280,7 @@ const workplaceSearchIntegrations: WorkplaceSearchIntegration[] = [ } ), categories: ['enterprise_search', 'file_storage', 'microsoft_365'], - uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/sharepoint_server', + uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/share_point_server/custom', }, { id: 'slack', @@ -308,7 +308,7 @@ const workplaceSearchIntegrations: WorkplaceSearchIntegration[] = [ } ), categories: ['enterprise_search', 'microsoft_365', 'communications', 'productivity'], - uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/teams', + uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/teams/custom', }, { id: 'zendesk', @@ -336,7 +336,7 @@ const workplaceSearchIntegrations: WorkplaceSearchIntegration[] = [ } ), categories: ['enterprise_search', 'communications', 'productivity'], - uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/zoom', + uiInternalPath: '/app/enterprise_search/workplace_search/sources/add/zoom/custom', }, ]; diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/curations.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/curations.test.ts index b930b449e97d1..8e2221b8d8f32 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/curations.test.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/curations.test.ts @@ -195,13 +195,13 @@ describe('curations routes', () => { }); }); - describe('GET /internal/app_search/engines/{engineName}/curations/find_or_create', () => { + describe('POST /internal/app_search/engines/{engineName}/curations/find_or_create', () => { let mockRouter: MockRouter; beforeEach(() => { jest.clearAllMocks(); mockRouter = new MockRouter({ - method: 'get', + method: 'post', path: '/internal/app_search/engines/{engineName}/curations/find_or_create', }); @@ -219,12 +219,12 @@ describe('curations routes', () => { describe('validates', () => { it('required query param', () => { - const request = { query: { query: 'some query' } }; + const request = { body: { query: 'some query' } }; mockRouter.shouldValidate(request); }); it('missing query', () => { - const request = { query: {} }; + const request = { body: {} }; mockRouter.shouldThrow(request); }); }); diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/curations.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/curations.ts index a7282e5dc6cc4..27927f2c36913 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/curations.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/curations.ts @@ -105,14 +105,14 @@ export function registerCurationsRoutes({ }) ); - router.get( + router.post( { path: '/internal/app_search/engines/{engineName}/curations/find_or_create', validate: { params: schema.object({ engineName: schema.string(), }), - query: schema.object({ + body: schema.object({ query: schema.string(), }), }, diff --git a/x-pack/plugins/file_upload/common/utils.ts b/x-pack/plugins/file_upload/common/utils.ts deleted file mode 100644 index 5ef6c56392e56..0000000000000 --- a/x-pack/plugins/file_upload/common/utils.ts +++ /dev/null @@ -1,19 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -export const isPopulatedObject = ( - arg: unknown, - requiredAttributes: U[] = [] -): arg is Record => { - return ( - typeof arg === 'object' && - arg !== null && - Object.keys(arg).length > 0 && - (requiredAttributes.length === 0 || - requiredAttributes.every((d) => ({}.hasOwnProperty.call(arg, d)))) - ); -}; diff --git a/x-pack/plugins/file_upload/public/importer/importer.ts b/x-pack/plugins/file_upload/public/importer/importer.ts index 58809e736720c..8928c4849435f 100644 --- a/x-pack/plugins/file_upload/public/importer/importer.ts +++ b/x-pack/plugins/file_upload/public/importer/importer.ts @@ -8,6 +8,7 @@ import { chunk, intersection } from 'lodash'; import moment from 'moment'; import { i18n } from '@kbn/i18n'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { getHttp } from '../kibana_services'; import { MB } from '../../common/constants'; import type { @@ -19,7 +20,6 @@ import type { IngestPipeline, } from '../../common/types'; import { CreateDocsResponse, IImporter, ImportResults } from './types'; -import { isPopulatedObject } from '../../common/utils'; const CHUNK_SIZE = 5000; const REDUCED_CHUNK_SIZE = 100; diff --git a/x-pack/plugins/file_upload/server/get_time_field_range.ts b/x-pack/plugins/file_upload/server/get_time_field_range.ts index e8b21e6807a8f..32bf1766f8d90 100644 --- a/x-pack/plugins/file_upload/server/get_time_field_range.ts +++ b/x-pack/plugins/file_upload/server/get_time_field_range.ts @@ -7,7 +7,7 @@ import { IScopedClusterClient } from '@kbn/core/server'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; -import { isPopulatedObject } from '../common/utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export async function getTimeFieldRange( client: IScopedClusterClient, diff --git a/x-pack/plugins/file_upload/server/utils/runtime_field_utils.ts b/x-pack/plugins/file_upload/server/utils/runtime_field_utils.ts index 0daf9713d8263..75c2aa886ef68 100644 --- a/x-pack/plugins/file_upload/server/utils/runtime_field_utils.ts +++ b/x-pack/plugins/file_upload/server/utils/runtime_field_utils.ts @@ -7,7 +7,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { RUNTIME_FIELD_TYPES } from '@kbn/data-plugin/common'; -import { isPopulatedObject } from '../../common/utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; type RuntimeType = typeof RUNTIME_FIELD_TYPES[number]; diff --git a/x-pack/plugins/fleet/common/constants/agent_policy.ts b/x-pack/plugins/fleet/common/constants/agent_policy.ts index 316c66d2c75d6..3a24bbd4a18c0 100644 --- a/x-pack/plugins/fleet/common/constants/agent_policy.ts +++ b/x-pack/plugins/fleet/common/constants/agent_policy.ts @@ -26,3 +26,5 @@ export const AGENT_POLICY_DEFAULT_MONITORING_DATASETS = [ 'elastic_agent.heartbeat', 'elastic_agent.cloudbeat', ]; + +export const LICENSE_FOR_SCHEDULE_UPGRADE = 'platinum'; diff --git a/x-pack/plugins/fleet/common/constants/routes.ts b/x-pack/plugins/fleet/common/constants/routes.ts index 7b185960dcb7b..33bf1b6f6b5b7 100644 --- a/x-pack/plugins/fleet/common/constants/routes.ts +++ b/x-pack/plugins/fleet/common/constants/routes.ts @@ -54,6 +54,7 @@ export const PACKAGE_POLICY_API_ROUTES = { DELETE_PATTERN: `${PACKAGE_POLICY_API_ROOT}/delete`, UPGRADE_PATTERN: `${PACKAGE_POLICY_API_ROOT}/upgrade`, DRYRUN_PATTERN: `${PACKAGE_POLICY_API_ROOT}/upgrade/dryrun`, + ORPHANED_INTEGRATION_POLICIES: `${INTERNAL_ROOT}/orphaned_integration_policies`, }; // Agent policy API routes @@ -92,6 +93,7 @@ export const SETTINGS_API_ROUTES = { // App API routes export const APP_API_ROUTES = { + HEALTH_CHECK_PATTERN: `${API_ROOT}/health_check`, CHECK_PERMISSIONS_PATTERN: `${API_ROOT}/check-permissions`, GENERATE_SERVICE_TOKEN_PATTERN: `${API_ROOT}/service_tokens`, // deprecated since 8.0 diff --git a/x-pack/plugins/fleet/common/services/routes.ts b/x-pack/plugins/fleet/common/services/routes.ts index a8a6c34f06f3c..8c66a11cd3569 100644 --- a/x-pack/plugins/fleet/common/services/routes.ts +++ b/x-pack/plugins/fleet/common/services/routes.ts @@ -19,6 +19,7 @@ import { SETTINGS_API_ROUTES, APP_API_ROUTES, K8S_API_ROUTES, + PRECONFIGURATION_API_ROUTES, } from '../constants'; export const epmRouteService = { @@ -105,6 +106,10 @@ export const packagePolicyRouteService = { getDryRunPath: () => { return PACKAGE_POLICY_API_ROUTES.DRYRUN_PATTERN; }, + + getOrphanedIntegrationPoliciesPath: () => { + return PACKAGE_POLICY_API_ROUTES.ORPHANED_INTEGRATION_POLICIES; + }, }; export const agentPolicyRouteService = { @@ -150,6 +155,14 @@ export const agentPolicyRouteService = { getK8sFullDownloadPath: () => { return K8S_API_ROUTES.K8S_DOWNLOAD_PATTERN; }, + + getResetOnePreconfiguredAgentPolicyPath: (agentPolicyId: string) => { + return PRECONFIGURATION_API_ROUTES.RESET_ONE_PATTERN.replace(`{agentPolicyId}`, agentPolicyId); + }, + + getResetAllPreconfiguredAgentPolicyPath: () => { + return PRECONFIGURATION_API_ROUTES.RESET_PATTERN; + }, }; export const dataStreamRouteService = { diff --git a/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts b/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts index 35202a0eb42aa..b2cb1a4561394 100644 --- a/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts +++ b/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts @@ -49,6 +49,7 @@ export type UpdatePackagePolicyResponse = CreatePackagePolicyResponse; export interface DeletePackagePoliciesRequest { body: { packagePolicyIds: string[]; + force?: boolean; }; } diff --git a/x-pack/plugins/fleet/dev_docs/fleet_debugger.md b/x-pack/plugins/fleet/dev_docs/fleet_debugger.md new file mode 100644 index 0000000000000..cafaeaae71f37 --- /dev/null +++ b/x-pack/plugins/fleet/dev_docs/fleet_debugger.md @@ -0,0 +1,27 @@ +# Fleet Debugger + +Fleet includes a "debug" interface that provides some insight and data management capabilities around Fleet's underlying data. This interface can be used to diagnose issues, assist support engineers, and restore functionality to broken Fleet installations. + +![Fleet Debugger UI Screenshot](https://user-images.githubusercontent.com/6766512/167193984-fcb100c4-729d-4a0b-ae64-2b280272da96.png) + +## Accessing the Fleet debugger + +The debugger is served at `/app/fleet/_debug`. This page shares the same permissions requirement as other `/fleet` pages, so you'll need a user with the `fleet.all` permission. + +## Using the Fleet debugger + +The Fleet debugger provides debugger modules for the following Fleet data: + +- Agent Policies +- Installed Integrations +- Saved Objects +- System Indices +- Preconfiguration +- "Orphaned" Integration Policies + +Each module contains an explanation of its functionality and behavior, but generally the goal of each module is to + +1. Provide visibility into the underlying data for the given object +1. Provide cleanup/reset functionality in order to recover from malformed data that may be preventing normal usage of Fleet + +The debugger should be used when possible to assist with SDH's when we request things like a copy/paste of a given policy object or for some cleanup operation to be run via `cURL`. As common SDH tasks are identified, the debugger should be expanded to suit the Fleet UI team's and the support team's needs. diff --git a/x-pack/plugins/fleet/public/applications/fleet/app.tsx b/x-pack/plugins/fleet/public/applications/fleet/app.tsx index eb8b01d831cd5..ca8083fb51325 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/app.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/app.tsx @@ -58,6 +58,7 @@ import { MissingESRequirementsPage } from './sections/agents/agent_requirements_ import { CreatePackagePolicyPage } from './sections/agent_policy/create_package_policy_page'; import { EnrollmentTokenListPage } from './sections/agents/enrollment_token_list_page'; import { SettingsApp } from './sections/settings'; +import { DebugPage } from './sections/debug'; const FEEDBACK_URL = 'https://ela.st/fleet-feedback'; @@ -326,6 +327,10 @@ export const AppRoutes = memo( + + + + {/* TODO: Move this route to the Integrations app */} diff --git a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/advanced_tab.tsx b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/advanced_tab.tsx index 8ecdffce3ed44..02cc458295677 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/advanced_tab.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/advanced_tab.tsx @@ -63,7 +63,7 @@ export const AdvancedTab: React.FunctionComponent = ({ selecte isFleetServerReady, serviceToken, fleetServerHost: fleetServerHostForm.fleetServerHost, - fleetServerPolicyId, + fleetServerPolicyId: fleetServerPolicyId || selectedPolicyId, deploymentMode, disabled: !Boolean(serviceToken), }), diff --git a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/create_service_token.tsx b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/create_service_token.tsx index dcfa150c2d32c..6d8d5014bbb61 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/create_service_token.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/create_service_token.tsx @@ -38,7 +38,7 @@ const CommandCode = styled.div.attrs(() => { className: 'eui-textBreakAll', }; })` - margin-right: ${(props) => props.theme.eui.paddingSizes.m}; + margin-right: ${(props) => props.theme.eui.euiSizeM}; `; export const getGenerateServiceTokenStep = ({ diff --git a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/select_agent_policy.tsx b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/select_agent_policy.tsx index d7f2301b663f1..24099534db80c 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/select_agent_policy.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/components/fleet_server_instructions/steps/select_agent_policy.tsx @@ -26,7 +26,7 @@ export const getSelectAgentPolicyStep = ({ }): EuiStepProps => { return { title: - eligibleFleetServerPolicies.length === 0 + eligibleFleetServerPolicies.length === 0 && !policyId ? i18n.translate('xpack.fleet.fleetServerSetup.stepCreateAgentPolicyTitle', { defaultMessage: 'Create a policy for Fleet Server', }) diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/components/steps/step_select_hosts.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/components/steps/step_select_hosts.tsx index 93aa2b37bfe3a..7c7b5194b39bf 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/components/steps/step_select_hosts.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/components/steps/step_select_hosts.tsx @@ -27,7 +27,7 @@ export enum SelectedPolicyTab { const StyledEuiTabbedContent = styled(EuiTabbedContent)` [role='tabpanel'] { - padding-top: ${(props) => props.theme.eui.paddingSizes.m}; + padding-top: ${(props) => props.theme.eui.euiSizeM}; } `; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.tsx index 5ac9d65445f09..22ed7957666b1 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.tsx @@ -68,7 +68,7 @@ import { CreatePackagePolicySinglePageLayout, PostInstallAddAgentModal } from '. const StepsWithLessPadding = styled(EuiSteps)` .euiStep__content { - padding-bottom: ${(props) => props.theme.eui.paddingSizes.m}; + padding-bottom: ${(props) => props.theme.eui.euiSizeM}; } // compensating for EuiBottomBar hiding the content diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_details/agent_details_integrations.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_details/agent_details_integrations.tsx index c7948aff6c212..2e238d4142f1d 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_details/agent_details_integrations.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_details/agent_details_integrations.tsx @@ -36,18 +36,18 @@ const StyledEuiAccordion = styled(EuiAccordion)` } .euiAccordion__triggerWrapper { - padding-left: ${(props) => props.theme.eui.paddingSizes.m}; + padding-left: ${(props) => props.theme.eui.euiSizeM}; } &.euiAccordion-isOpen { .euiAccordion__childWrapper { - padding: ${(props) => props.theme.eui.paddingSizes.m}; + padding: ${(props) => props.theme.eui.euiSizeM}; padding-top: 0px; } } .ingest-integration-title-button { - padding: ${(props) => props.theme.eui.paddingSizes.s}; + padding: ${(props) => props.theme.eui.euiSizeS}; } .euiTableRow:last-child .euiTableRowCell { diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx index 8d35b3bcd19f1..6148b39b088af 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx @@ -24,6 +24,8 @@ import { AgentUnenrollAgentModal, AgentUpgradeAgentModal, } from '../../components'; +import { useLicense } from '../../../../hooks'; +import { LICENSE_FOR_SCHEDULE_UPGRADE } from '../../../../../../../common'; import type { SelectionMode } from './types'; @@ -47,6 +49,9 @@ export const AgentBulkActions: React.FunctionComponent = ({ selectedAgents, refreshAgents, }) => { + const licenseService = useLicense(); + const isLicenceAllowingScheduleUpgrade = licenseService.hasAtLeast(LICENSE_FOR_SCHEDULE_UPGRADE); + // Bulk actions menu states const [isMenuOpen, setIsMenuOpen] = useState(false); const closeMenu = () => setIsMenuOpen(false); @@ -133,7 +138,7 @@ export const AgentBulkActions: React.FunctionComponent = ({ /> ), icon: , - disabled: !atLeastOneActiveAgentSelected, + disabled: !atLeastOneActiveAgentSelected || !isLicenceAllowingScheduleUpgrade, onClick: () => { closeMenu(); setUpgradeModalState({ isOpen: true, isScheduled: true }); diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx index d3af03983fa0b..b359001750522 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx @@ -65,7 +65,7 @@ const statusFilters = [ ]; const ClearAllTagsFilterItem = styled(EuiFilterSelectItem)` - padding: ${(props) => props.theme.eui.paddingSizes.s}; + padding: ${(props) => props.theme.eui.euiSizeS}; `; export const SearchAndFilterBar: React.FunctionComponent<{ diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx new file mode 100644 index 0000000000000..71ee096f1e4fa --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/agent_policy_debugger.tsx @@ -0,0 +1,172 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React, { useState } from 'react'; +import { + EuiButton, + EuiCallOut, + EuiCode, + EuiComboBox, + EuiFlexGroup, + EuiFlexItem, + EuiLink, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useQuery } from 'react-query'; + +import { FormattedMessage } from '@kbn/i18n-react'; +import { i18n } from '@kbn/i18n'; + +import { sendGetAgentPolicies, useLink } from '../../../hooks'; +import { SO_SEARCH_LIMIT } from '../../../constants'; + +import { policyHasFleetServer } from '../../../services'; +import type { AgentPolicy } from '../../../types'; +import { AgentPolicyDeleteProvider } from '../../agent_policy/components'; + +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchAgentPolicies = async () => { + const response = await sendGetAgentPolicies({ + full: true, + perPage: SO_SEARCH_LIMIT, + sortOrder: 'asc', + }); + + if (response.error) { + throw new Error(response.error.message); + } + + return response; +}; + +export const AgentPolicyDebugger: React.FunctionComponent = () => { + const { getHref } = useLink(); + const [selectedPolicyId, setSelectedPolicyId] = useState(); + + // TODO: Depending on the number of agent policies, this might need to be switched to + // `useInfinite` query with an infinite scrolling approach in the dropdown options. + const { data, status } = useQuery('debug-agent-policies', fetchAgentPolicies); + + const agentPolicies = data?.data?.items ?? []; + const comboBoxOptions = agentPolicies.map((policy) => ({ + label: `${policy.name} - ${policy.id}`, + value: policy.id, + })); + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find((option) => option.value === selectedPolicyId)!] + : []; + + const selectedAgentPolicy = agentPolicies.find((policy) => policy.id === selectedPolicyId); + + const onDelete = () => { + setSelectedPolicyId(undefined); + queryClient.invalidateQueries('debug-agent-policies'); + }; + + if (status === 'error') { + return ( + + + + ); + } + + return ( + <> + +

+ id }} + /> +

+ + + + + + + { + // Handle "clear" action + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + {selectedPolicyId && ( + + {(deleteAgentPolicyPrompt) => { + return ( + +
+ deleteAgentPolicyPrompt(selectedPolicyId, onDelete)} + > + + +
+ + ); + }} + + )} + + + {selectedPolicyId && ( + <> + + + + + + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx new file mode 100644 index 0000000000000..3addcaa862c3f --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/code_block.tsx @@ -0,0 +1,38 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { CodeEditor } from '@kbn/kibana-react-plugin/public'; + +/** + * A read-only code block with various default settings suitable for displaying API responses, etc + */ +export const CodeBlock: React.FunctionComponent<{ value: string }> = ({ value }) => { + return ( + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx new file mode 100644 index 0000000000000..7c0c81858414a --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/fleet_index_debugger.tsx @@ -0,0 +1,120 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiCallOut, + EuiComboBox, + EuiFlexGroup, + EuiFlexItem, + EuiFormRow, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { sendRequest } from '../../../hooks'; + +import { CodeBlock } from './code_block'; + +const fetchIndex = async (index?: string) => { + if (!index) return; + const path = `/${index}/_search`; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + }); + + return response; +}; + +export const FleetIndexDebugger = () => { + const indices = [ + { label: '.fleet-agents', value: '.fleet-agents' }, + { label: '.fleet-actions', value: '.fleet-actions' }, + ]; + const [index, setIndex] = useState(); + + const { data: indexResult, status } = useQuery( + ['debug-indices', index], + () => fetchIndex(index), + { + retry: false, + } + ); + + const selectedOptions = index ? [indices.find((option) => option.value === index)!] : []; + + return ( + <> + +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setIndex(undefined); + } else { + setIndex(newSelectedOptions[0].value as string); + } + }} + /> + + + + {indexResult?.error && ( + <> + + + {(indexResult?.error as any)?.error?.reason ?? ( + + )} + + + )} + + {indexResult && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx new file mode 100644 index 0000000000000..6a89a696874a7 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/index.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './agent_policy_debugger'; +export * from './integration_debugger'; +export * from './saved_object_debugger'; +export * from './preconfiguration_debugger'; +export * from './fleet_index_debugger'; +export * from './orphaned_integration_policy_debugger'; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx new file mode 100644 index 0000000000000..92f82285357f0 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/integration_debugger.tsx @@ -0,0 +1,314 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiButton, + EuiButtonEmpty, + EuiCallOut, + EuiComboBox, + EuiConfirmModal, + EuiFlexGroup, + EuiFlexItem, + EuiHighlight, + EuiIcon, + EuiLink, + EuiSpacer, + EuiText, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { getEuiIconType } from '../../../../../services/icons'; + +import { + sendGetPackages, + sendInstallPackage, + sendRemovePackage, + useLink, + useStartServices, +} from '../../../hooks'; +import type { PackageListItem } from '../../../types'; +import { queryClient } from '..'; +import { pkgKeyFromPackageInfo } from '../../../services'; + +const fetchInstalledIntegrations = async () => { + const response = await sendGetPackages({ experimental: true }); + + if (response.error) { + throw new Error(response.error.message); + } + + const installedIntegrations = response.data?.items.filter(({ status }) => status === 'installed'); + + return installedIntegrations; +}; + +export const IntegrationDebugger: React.FunctionComponent = () => { + const { http, notifications } = useStartServices(); + const { getHref } = useLink(); + + const [selectedIntegrationId, setSelectedIntegrationId] = useState(); + const [isReinstallModalVisible, setIsReinstallModalVisible] = useState(false); + const [isUninstallModalVisible, setIsUninstallModalVisible] = useState(false); + + const integrations = useQuery('debug-integrations', fetchInstalledIntegrations); + + const uninstallMutation = useMutation(async (integration: PackageListItem) => { + const response = await sendRemovePackage(integration.name, integration.version, true); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.uninstall.error', { + defaultMessage: 'Error uninstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: response.error.message, + }); + + setIsUninstallModalVisible(false); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.integrationDebugger.uninstall.success', { + defaultMessage: 'Successfully uninstalled {integrationTitle}', + values: { integrationTitle: integration.title }, + }) + ); + + setSelectedIntegrationId(undefined); + setIsUninstallModalVisible(false); + + queryClient.invalidateQueries('debug-integrations'); + + return response.data; + }); + + const reinstallMutation = useMutation(async (integration: PackageListItem) => { + const uninstallResponse = await sendRemovePackage(integration.name, integration.version, true); + + if (uninstallResponse.error) { + notifications.toasts.addError(uninstallResponse.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.error', { + defaultMessage: 'Error reinstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: uninstallResponse.error.message, + }); + + setIsReinstallModalVisible(false); + throw new Error(uninstallResponse.error.message); + } + + const installResponse = await sendInstallPackage(integration.name, integration.version); + + if (installResponse.error) { + notifications.toasts.addError(installResponse.error, { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.error', { + defaultMessage: 'Error reinstalling {integrationTitle}', + values: { integrationTitle: integration.title }, + }), + toastMessage: installResponse.error.message, + }); + + setIsReinstallModalVisible(false); + throw new Error(installResponse.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.integrationDebugger.reinstall.success', { + defaultMessage: 'Successfully reinstalled {integrationTitle}', + values: { integrationTitle: integration.title }, + }) + ); + + setSelectedIntegrationId(undefined); + setIsReinstallModalVisible(false); + + queryClient.invalidateQueries('debug-integrations'); + + return installResponse.data; + }); + + if (integrations.status === 'error') { + return ( + + + + ); + } + + const comboBoxOptions = + integrations.data?.map((integration) => ({ + label: integration.name, + value: integration.id, + icon: getEuiIconType(integration, http.basePath), + })) ?? []; + + const selectedOptions = selectedIntegrationId + ? [comboBoxOptions.find((option) => option.value === selectedIntegrationId)!] + : []; + + const selectedIntegration = integrations.data?.find( + (integration) => integration.id === selectedIntegrationId + ); + + return ( + <> + +

+ +

+ +

+ +

+ + + + + + + 0 ? ( + + + + ) : undefined + } + renderOption={(option, searchValue, contentClassName) => ( + + +   + {option.label} + + )} + onChange={(newSelectedOptions) => { + // Handle "clear" action + if (!newSelectedOptions.length) { + setSelectedIntegrationId(undefined); + } else { + setSelectedIntegrationId(newSelectedOptions[0].value); + } + }} + /> + + + {selectedIntegration && ( + + + setIsReinstallModalVisible(true)}> + Reinstall + + + + + setIsUninstallModalVisible(true)}> + Uninstall + + + + {isReinstallModalVisible && ( + setIsReinstallModalVisible(false)} + onConfirm={() => reinstallMutation.mutate(selectedIntegration)} + isLoading={reinstallMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.cancelReinstall', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.confirmReinstall', + { defaultMessage: 'Reinstall' } + )} + > + + + )} + + {isUninstallModalVisible && ( + setIsUninstallModalVisible(false)} + onConfirm={() => uninstallMutation.mutate(selectedIntegration)} + isLoading={uninstallMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.cancelUninstall', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.integrationDebugger.confirmUninstall', + { defaultMessage: 'Uninstall' } + )} + > + + + )} + + )} + + + {selectedIntegration && ( + <> + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx new file mode 100644 index 0000000000000..abc84ad425900 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/orphaned_integration_policy_debugger.tsx @@ -0,0 +1,262 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiSpacer, + EuiText, + EuiFlexGroup, + EuiComboBox, + EuiFlexItem, + EuiButton, + EuiConfirmModal, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { + sendDeletePackagePolicy, + sendGetOrphanedIntegrationPolicies, + useStartServices, +} from '../../../hooks'; +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchOrphanedPolicies = async () => { + const response = await sendGetOrphanedIntegrationPolicies(); + + if (response.error) { + throw new Error(response.error.message); + } + + return response.data?.items ?? []; +}; + +export const OrphanedIntegrationPolicyDebugger: React.FunctionComponent = () => { + const { notifications } = useStartServices(); + + const [selectedPolicyId, setSelectedPolicyId] = useState(); + const [isDeleteModalVisible, setIsDeleteModalVisible] = useState(false); + const [isDeleteAllModalVisible, setIsDeleteAllModalVisible] = useState(false); + + const { data: orphanedPolicies } = useQuery('debug-orphaned-policies', fetchOrphanedPolicies); + + const comboBoxOptions = + orphanedPolicies?.map((policy: { id: string; name: string }) => ({ + label: policy.name, + value: policy.id, + })) ?? []; + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find(({ value }: { value: string }) => value === selectedPolicyId)!] + : []; + + const selectedPolicy = orphanedPolicies?.find( + (policy: { id: string }) => policy.id === selectedPolicyId + ); + + const deleteOnePolicyMutation = useMutation(async (policyId: string) => { + const response = await sendDeletePackagePolicy({ + packagePolicyIds: [policyId], + force: true, + }); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteError', { + defaultMessage: 'Error deleting policy', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteSuccess', { + defaultMessage: 'Successfully deleted orphaned policy', + }) + ); + queryClient.invalidateQueries('debug-orphaned-policies'); + setSelectedPolicyId(undefined); + setIsDeleteModalVisible(false); + + return response.data; + }); + + const deleteAllPoliciesMutation = useMutation(async () => { + const response = await sendDeletePackagePolicy({ + packagePolicyIds: orphanedPolicies?.map((policy: { id: string }) => policy.id), + force: true, + }); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteAllError', + { defaultMessage: 'Error deleting orphaned policies' } + ), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.deleteAllSuccess', { + defaultMessage: 'Successfully deleted all orphaned policies', + }) + ); + queryClient.invalidateQueries('debug-orphaned-policies'); + setSelectedPolicyId(undefined); + setIsDeleteAllModalVisible(false); + + return response.data; + }); + + return ( + <> + +

+ +

+ +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + +
+ setIsDeleteModalVisible(true)} + > + + +
+ + + +
+ setIsDeleteAllModalVisible(true)} + > + + +
+ + + + {isDeleteModalVisible && selectedPolicy && selectedPolicyId && ( + setIsDeleteModalVisible(false)} + onConfirm={() => deleteOnePolicyMutation.mutate(selectedPolicyId)} + isLoading={deleteOnePolicyMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.cancelDelete', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.confirmDelete', + { defaultMessage: 'Delete' } + )} + > + + + )} + + {isDeleteAllModalVisible && ( + setIsDeleteAllModalVisible(false)} + onConfirm={() => deleteAllPoliciesMutation.mutate()} + isLoading={deleteAllPoliciesMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.cancelDeleteAll', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.orphanedIntegrationPolicyDebugger.confirmDeleteAll', + { defaultMessage: 'Delete all' } + )} + > + + + )} + + {selectedPolicyId && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx new file mode 100644 index 0000000000000..35e9bcba75492 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/preconfiguration_debugger.tsx @@ -0,0 +1,272 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { + EuiSpacer, + EuiText, + EuiCode, + EuiFlexGroup, + EuiComboBox, + EuiFlexItem, + EuiButton, + EuiLink, + EuiConfirmModal, +} from '@elastic/eui'; +import { useMutation, useQuery } from 'react-query'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { + sendGetAgentPolicies, + sendResetAllPreconfiguredAgentPolicies, + sendResetOnePreconfiguredAgentPolicy, + useLink, + useStartServices, +} from '../../../hooks'; +import { AGENT_POLICY_SAVED_OBJECT_TYPE, SO_SEARCH_LIMIT } from '../../../constants'; +import { queryClient } from '..'; + +import { CodeBlock } from './code_block'; + +const fetchPreconfiguredPolicies = async () => { + const kuery = `${AGENT_POLICY_SAVED_OBJECT_TYPE}.is_preconfigured:true`; + + const response = await sendGetAgentPolicies({ kuery, perPage: SO_SEARCH_LIMIT, full: true }); + + if (response.error) { + throw new Error(response.error.message); + } + + return response.data?.items ?? []; +}; + +export const PreconfigurationDebugger: React.FunctionComponent = () => { + const { getHref } = useLink(); + const { notifications } = useStartServices(); + + const [selectedPolicyId, setSelectedPolicyId] = useState(); + const [isResetModalVisible, setIsResetModalVisible] = useState(false); + const [isResetAllModalVisible, setIsResetAllModalVisible] = useState(false); + + const preconfiguredPolicies = useQuery( + 'debug-preconfigured-policies', + fetchPreconfiguredPolicies + ); + + const comboBoxOptions = + preconfiguredPolicies.data?.map((policy) => ({ + label: policy.name, + value: policy.id, + })) ?? []; + + const selectedOptions = selectedPolicyId + ? [comboBoxOptions.find(({ value }) => value === selectedPolicyId)!] + : []; + + const selectedPolicy = preconfiguredPolicies.data?.find( + (policy) => policy.id === selectedPolicyId + ); + + const resetOnePolicyMutation = useMutation(async (policyId: string) => { + const response = await sendResetOnePreconfiguredAgentPolicy(policyId); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetError', { + defaultMessage: 'Error resetting policy', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetSuccess', { + defaultMessage: 'Successfully reset policy', + }) + ); + queryClient.invalidateQueries('debug-preconfigured-policies'); + setSelectedPolicyId(undefined); + setIsResetModalVisible(false); + + return response.data; + }); + + const resetAllPoliciesMutation = useMutation(async () => { + const response = await sendResetAllPreconfiguredAgentPolicies(); + + if (response.error) { + notifications.toasts.addError(response.error, { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetAllError', { + defaultMessage: 'Error resetting policies', + }), + toastMessage: response.error.message, + }); + throw new Error(response.error.message); + } + + notifications.toasts.addSuccess( + i18n.translate('xpack.fleet.debug.preconfigurationDebugger.resetAllSuccess', { + defaultMessage: 'Successfully reset policies', + }) + ); + queryClient.invalidateQueries('debug-preconfigured-policies'); + setSelectedPolicyId(undefined); + setIsResetAllModalVisible(false); + + return response.data; + }); + + return ( + <> + +

+ kibana.yml }} + /> +

+ +

+ +

+ + + + + + + { + if (!newSelectedOptions.length) { + setSelectedPolicyId(undefined); + } else { + setSelectedPolicyId(newSelectedOptions[0].value); + } + }} + /> + + + +
+ setIsResetModalVisible(true)} + > + + +
+ + + +
+ setIsResetAllModalVisible(true)} + > + + +
+ + + + {isResetModalVisible && selectedPolicy && selectedPolicyId && ( + setIsResetModalVisible(false)} + onConfirm={() => resetOnePolicyMutation.mutate(selectedPolicyId)} + isLoading={resetOnePolicyMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetModalCancel', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetModalConfirm', + { defaultMessage: 'Reset' } + )} + > + + + )} + + {isResetAllModalVisible && ( + setIsResetAllModalVisible(false)} + onConfirm={() => resetAllPoliciesMutation.mutate()} + isLoading={resetAllPoliciesMutation.isLoading} + cancelButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetAllModalCancel', + { defaultMessage: 'Cancel' } + )} + confirmButtonText={i18n.translate( + 'xpack.fleet.debug.preconfigurationDebugger.resetAllModalConfirm', + { defaultMessage: 'Reset all' } + )} + > + + + )} + + {selectedPolicyId && ( + <> + + + + + + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx new file mode 100644 index 0000000000000..c23b383d96f9d --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_debugger.tsx @@ -0,0 +1,178 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState, useRef } from 'react'; +import { useQuery } from 'react-query'; +import { + EuiFlexGroup, + EuiFlexItem, + EuiFormRow, + EuiSelect, + EuiSpacer, + EuiText, + EuiCallOut, +} from '@elastic/eui'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { sendRequest } from '../../../hooks'; + +import { CodeBlock } from './code_block'; +import { SavedObjectNamesCombo } from './saved_object_names_combo'; + +const fetchSavedObjects = async (type?: string, name?: string) => { + if (!type || !name) return; + const path = `/.kibana/_search`; + const body = { + query: { + bool: { + must: { + match: { [`${type}.name`]: name }, + }, + filter: { + term: { + type, + }, + }, + }, + }, + }; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + body, + }); + + if (response.error) { + throw new Error(response.error.message); + } + return response.data?.hits; +}; + +export const SavedObjectDebugger: React.FunctionComponent = () => { + const types = [ + { + value: 'ingest-agent-policies', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.agentPolicyLabel', { + defaultMessage: 'Agent policy', + }), + }, + { + value: 'ingest-package-policies', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.packagePolicyLabel', { + defaultMessage: 'Integration policy', + }), + }, + { + value: 'ingest-outputs', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.outputLabel', { + defaultMessage: 'Output', + }), + }, + { + value: 'epm-packages', + text: i18n.translate('xpack.fleet.debug.savedObjectDebugger.packageLabel', { + defaultMessage: 'Packages', + }), + }, + ]; + + const [type, setType] = useState(types[0].value); + const [name, setName] = useState(); + const [namesStatus, setNamesStatus] = useState(); + + const childRef = useRef<{ refetchNames: Function }>(); + + const onTypeChange = (e: any) => { + setType(e.target.value); + setName(undefined); + childRef.current!.refetchNames(); + }; + + const { data: savedObjectResult, status } = useQuery(['debug-saved-objects', type, name], () => + fetchSavedObjects(type, name) + ); + + return ( + <> + +

+ +

+ + + + + + + + onTypeChange(e)} + aria-label={i18n.translate('xpack.fleet.debug.savedObjectDebugger.selectTypeLabel', { + defaultMessage: 'Select saved object type', + })} + /> + + + + + + + + + + {(status === 'error' || namesStatus === 'error') && ( + <> + + + + + + )} + + {/* Allowing this to render while status === loading prevents the Code Block UI from + flickering when selecting a new object */} + {(savedObjectResult || status === 'loading') && ( + <> + + + + )} + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx new file mode 100644 index 0000000000000..9458bca298b9a --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/components/saved_object_names_combo.tsx @@ -0,0 +1,110 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { forwardRef, useImperativeHandle } from 'react'; +import { useQuery } from 'react-query'; +import { EuiComboBox } from '@elastic/eui'; + +import { i18n } from '@kbn/i18n'; + +import { sendRequest } from '../../../hooks'; + +const fetchSavedObjectNames = async (type: string) => { + const path = `/.kibana/_search`; + const body = { + size: 0, + query: { + bool: { + filter: { + term: { + type, + }, + }, + }, + }, + aggs: { + names: { + terms: { field: `${type}.name`, size: 500 }, + }, + }, + }; + const response = await sendRequest({ + method: 'post', + path: `/api/console/proxy`, + query: { + path, + method: 'GET', + }, + body, + }); + + if (response.error) { + throw new Error(response.error.message); + } + return response.data?.aggregations.names.buckets; +}; + +interface SavedObjectNamesComboProps { + name: string; + setName: Function; + type: string; + setNamesStatus: Function; +} + +export const SavedObjectNamesCombo = forwardRef( + ({ name, setName, type, setNamesStatus }: SavedObjectNamesComboProps, ref) => { + const { + data: savedObjectNames, + refetch, + status, + } = useQuery(['debug-saved-object-names', type], () => fetchSavedObjectNames(type), { + refetchOnWindowFocus: false, + }); + + setNamesStatus?.(status); + + useImperativeHandle(ref, () => ({ + refetchNames: refetch, + })); + + const comboBoxOptions = (savedObjectNames ?? []).map((obj: { key: string }) => ({ + label: obj.key, + value: obj.key, + })); + + const selectedOption = comboBoxOptions.find( + (option: { value: string }) => option.value === name + )!; + const selectedOptions = selectedOption ? [selectedOption] : []; + + return ( + { + if (!newSelectedOptions.length) { + setName(undefined); + } else { + setName(newSelectedOptions[0].value as string); + } + }} + /> + ); + } +); diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx new file mode 100644 index 0000000000000..b54a97d3b270c --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/debug/index.tsx @@ -0,0 +1,187 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { + EuiAccordion, + EuiCallOut, + EuiHorizontalRule, + EuiListGroup, + EuiPage, + EuiPageBody, + EuiPageHeader, + EuiSpacer, + EuiText, + EuiTitle, +} from '@elastic/eui'; +import { QueryClient, QueryClientProvider } from 'react-query'; +import { ReactQueryDevtools } from 'react-query/devtools'; + +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import { useLink, useStartServices } from '../../hooks'; + +import { + AgentPolicyDebugger, + IntegrationDebugger, + PreconfigurationDebugger, + FleetIndexDebugger, + SavedObjectDebugger, + OrphanedIntegrationPolicyDebugger, +} from './components'; + +// TODO: Evaluate moving this react-query initialization up to the main Fleet app +// setup if we end up pursuing wider adoption of react-query. +export const queryClient = new QueryClient(); + +const panels = [ + { + title: i18n.translate('xpack.fleet.debug.agentPolicyDebugger.title', { + defaultMessage: 'Agent Policy Debugger', + }), + id: 'agentPolicyDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.integrationDebugger.title', { + defaultMessage: 'Integration Debugger', + }), + id: 'integrationDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.savedObjectDebugger.title', { + defaultMessage: 'Saved Object Debugger', + }), + id: 'savedObjectDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.fleetIndexDebugger.title', { + defaultMessage: 'Fleet Index Debugger', + }), + id: 'fleetIndexDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.preconfigurationDebugger.title', { + defaultMessage: 'Preconfiguration Debugger', + }), + id: 'preconfigurationDebugger', + component: , + }, + { + title: i18n.translate('xpack.fleet.debug.orphanedIntegrationPolicyDebugger.title', { + defaultMessage: 'Orphaned Integration Policy Debugger', + }), + id: 'orphanedIntegrationPolicyDebugger', + component: , + }, +]; + +export const DebugPage: React.FunctionComponent = () => { + const { chrome } = useStartServices(); + const { getHref } = useLink(); + + chrome.docTitle.change(['Debug', 'Fleet']); + + return ( + + + + + + + + + + ), + strongLossOfData: ( + + + + ), + }} + /> + + + + + + {panels.map(({ title, id, component }) => ( + <> + +

{title}

+ + } + > + + {component} + + + + + ))} + + +

+ +

+ + + + + + + + + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/assets_facet_group.tsx b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/assets_facet_group.tsx index 0e9aae706f194..3bed1f7b5f84d 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/assets_facet_group.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/assets_facet_group.tsx @@ -34,11 +34,11 @@ import { } from '../constants'; const FirstHeaderRow = styled(EuiFlexGroup)` - padding: 0 0 ${(props) => props.theme.eui.paddingSizes.m} 0; + padding: 0 0 ${(props) => props.theme.eui.euiSizeM} 0; `; const HeaderRow = styled(EuiFlexGroup)` - padding: ${(props) => props.theme.eui.paddingSizes.m} 0; + padding: ${(props) => props.theme.eui.euiSizeM} 0; `; const FacetGroup = styled(EuiFacetGroup)` diff --git a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/requirements.tsx b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/requirements.tsx index 040d930e88a71..3d33b0bd32984 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/requirements.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/components/requirements.tsx @@ -20,7 +20,7 @@ export interface RequirementsProps { } const FlexGroup = styled(EuiFlexGroup)` - padding: 0 0 ${(props) => props.theme.eui.paddingSizes.m} 0; + padding: 0 0 ${(props) => props.theme.eui.euiSizeM} 0; margin: 0; `; const StyledVersion = styled(Version)` diff --git a/x-pack/plugins/fleet/public/components/agent_enrollment_flyout/agent_policy_select_create.tsx b/x-pack/plugins/fleet/public/components/agent_enrollment_flyout/agent_policy_select_create.tsx index 4dab3b054bc8d..35a65deffc70b 100644 --- a/x-pack/plugins/fleet/public/components/agent_enrollment_flyout/agent_policy_select_create.tsx +++ b/x-pack/plugins/fleet/public/components/agent_enrollment_flyout/agent_policy_select_create.tsx @@ -79,9 +79,9 @@ export const SelectCreateAgentPolicy: React.FC = ({ ); useEffect(() => { - setShowCreatePolicy(regularAgentPolicies.length === 0); + setShowCreatePolicy(regularAgentPolicies.length === 0 && !selectedPolicyId); setNewName(incrementPolicyName(regularAgentPolicies, isFleetServerPolicy)); - }, [regularAgentPolicies, isFleetServerPolicy]); + }, [regularAgentPolicies, isFleetServerPolicy, selectedPolicyId]); const onAgentPolicyCreated = useCallback( async (policy: AgentPolicy | null, errorMessage?: JSX.Element) => { diff --git a/x-pack/plugins/fleet/public/components/danger_eui_context_menu_item.tsx b/x-pack/plugins/fleet/public/components/danger_eui_context_menu_item.tsx index 969c8a4b07f74..87fb523121cfe 100644 --- a/x-pack/plugins/fleet/public/components/danger_eui_context_menu_item.tsx +++ b/x-pack/plugins/fleet/public/components/danger_eui_context_menu_item.tsx @@ -9,5 +9,5 @@ import styled from 'styled-components'; import { EuiContextMenuItem } from '@elastic/eui'; export const DangerEuiContextMenuItem = styled(EuiContextMenuItem)` - color: ${(props) => props.theme.eui.euiTextColors.danger}; + color: ${(props) => props.theme.eui.euiColorDangerText}; `; diff --git a/x-pack/plugins/fleet/public/components/header.tsx b/x-pack/plugins/fleet/public/components/header.tsx index 2a8b20240a4f6..5443477c976b7 100644 --- a/x-pack/plugins/fleet/public/components/header.tsx +++ b/x-pack/plugins/fleet/public/components/header.tsx @@ -26,9 +26,9 @@ const Wrapper = styled.div<{ maxWidth?: number }>` max-width: ${(props) => props.maxWidth || 1200}px; margin-left: auto; margin-right: auto; - padding-top: ${(props) => props.theme.eui.paddingSizes.xl}; - padding-left: ${(props) => props.theme.eui.paddingSizes.m}; - padding-right: ${(props) => props.theme.eui.paddingSizes.m}; + padding-top: ${(props) => props.theme.eui.euiSizeXL}; + padding-left: ${(props) => props.theme.eui.euiSizeM}; + padding-right: ${(props) => props.theme.eui.euiSizeM}; `; const Tabs = styled(EuiTabs)` diff --git a/x-pack/plugins/fleet/public/constants/page_paths.ts b/x-pack/plugins/fleet/public/constants/page_paths.ts index 26db09d68f41d..e7134f8549e27 100644 --- a/x-pack/plugins/fleet/public/constants/page_paths.ts +++ b/x-pack/plugins/fleet/public/constants/page_paths.ts @@ -17,7 +17,8 @@ export type StaticPage = | 'data_streams' | 'settings' | 'settings_edit_fleet_server_hosts' - | 'settings_create_outputs'; + | 'settings_create_outputs' + | 'debug'; export type DynamicPage = | 'integrations_all' @@ -67,6 +68,7 @@ export const FLEET_ROUTING_PATHS = { settings_edit_fleet_server_hosts: '/settings/edit-fleet-server-hosts', settings_create_outputs: '/settings/create-outputs', settings_edit_outputs: '/settings/outputs/:outputId', + debug: '/_debug', // TODO: Move this to the integrations app add_integration_to_policy: '/integrations/:pkgkey/add-integration/:integration?', @@ -190,4 +192,5 @@ export const pagePathGetters: { FLEET_ROUTING_PATHS.settings_edit_outputs.replace(':outputId', outputId as string), ], settings_create_outputs: () => [FLEET_BASE_PATH, FLEET_ROUTING_PATHS.settings_create_outputs], + debug: () => [FLEET_BASE_PATH, FLEET_ROUTING_PATHS.debug], }; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts b/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts index 777a74b079d7b..248fb60f5bf70 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/agent_policy.ts @@ -115,3 +115,19 @@ export const sendDeleteAgentPolicy = (body: DeleteAgentPolicyRequest['body']) => body: JSON.stringify(body), }); }; + +export const sendResetOnePreconfiguredAgentPolicy = (agentPolicyId: string) => { + return sendRequest({ + path: agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath(agentPolicyId), + method: 'post', + body: JSON.stringify({}), + }); +}; + +export const sendResetAllPreconfiguredAgentPolicies = () => { + return sendRequest({ + path: agentPolicyRouteService.getResetAllPreconfiguredAgentPolicyPath(), + method: 'post', + body: JSON.stringify({}), + }); +}; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/epm.ts b/x-pack/plugins/fleet/public/hooks/use_request/epm.ts index 7864f08d19a6e..02959d06327cb 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/epm.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/epm.ts @@ -109,10 +109,13 @@ export const sendInstallPackage = (pkgName: string, pkgVersion: string) => { }); }; -export const sendRemovePackage = (pkgName: string, pkgVersion: string) => { +export const sendRemovePackage = (pkgName: string, pkgVersion: string, force: boolean = false) => { return sendRequest({ path: epmRouteService.getRemovePath(pkgName, pkgVersion), method: 'delete', + body: { + force, + }, }); }; diff --git a/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts b/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts index 0d2e1179108f2..3b2b14960379f 100644 --- a/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts +++ b/x-pack/plugins/fleet/public/hooks/use_request/package_policy.ts @@ -109,3 +109,10 @@ export function sendUpgradePackagePolicy(packagePolicyIds: string[]) { }), }); } + +export function sendGetOrphanedIntegrationPolicies() { + return sendRequest({ + path: packagePolicyRouteService.getOrphanedIntegrationPoliciesPath(), + method: 'get', + }); +} diff --git a/x-pack/plugins/fleet/public/search_provider.ts b/x-pack/plugins/fleet/public/search_provider.ts index 9ce1ebc14c5e9..b632c3d1301fc 100644 --- a/x-pack/plugins/fleet/public/search_provider.ts +++ b/x-pack/plugins/fleet/public/search_provider.ts @@ -10,18 +10,17 @@ import type { Observable } from 'rxjs'; import { from, of, combineLatest } from 'rxjs'; import { map, shareReplay, takeUntil } from 'rxjs/operators'; -import { ICON_TYPES } from '@elastic/eui'; - import type { GlobalSearchResultProvider, GlobalSearchProviderResult, } from '@kbn/global-search-plugin/public'; -import { epmRouteService, INTEGRATIONS_PLUGIN_ID } from '../common'; +import { INTEGRATIONS_PLUGIN_ID } from '../common'; import { sendGetPackages } from './hooks'; import type { GetPackagesResponse, PackageListItem } from './types'; import { pagePathGetters } from './constants'; +import { getEuiIconType } from './services/icons'; const packageType = 'integration'; @@ -36,18 +35,6 @@ const createPackages$ = () => shareReplay(1) ); -const getEuiIconType = (pkg: PackageListItem, basePath: IBasePath): string | undefined => { - const pkgIcon = pkg.icons?.find((icon) => icon.type === 'image/svg+xml'); - if (!pkgIcon) { - // If no valid SVG is available, attempt to fallback to built-in EUI icons - return ICON_TYPES.find((key) => key.toLowerCase() === `logo${pkg.name}`); - } - - return basePath.prepend( - epmRouteService.getFilePath(`/package/${pkg.name}/${pkg.version}${pkgIcon.src}`) - ); -}; - /** Exported for testing only @internal */ export const toSearchResult = ( pkg: PackageListItem, diff --git a/x-pack/plugins/fleet/public/services/icons.ts b/x-pack/plugins/fleet/public/services/icons.ts new file mode 100644 index 0000000000000..89287169d7537 --- /dev/null +++ b/x-pack/plugins/fleet/public/services/icons.ts @@ -0,0 +1,24 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ICON_TYPES } from '@elastic/eui'; +import type { IBasePath } from '@kbn/core/public'; + +import { epmRouteService } from '../applications/fleet/services'; +import type { PackageListItem } from '../types'; + +export const getEuiIconType = (pkg: PackageListItem, basePath: IBasePath): string | undefined => { + const pkgIcon = pkg.icons?.find((icon) => icon.type === 'image/svg+xml'); + if (!pkgIcon) { + // If no valid SVG is available, attempt to fallback to built-in EUI icons + return ICON_TYPES.find((key) => key.toLowerCase() === `logo${pkg.name}`); + } + + return basePath.prepend( + epmRouteService.getFilePath(`/package/${pkg.name}/${pkg.version}${pkgIcon.src}`) + ); +}; diff --git a/x-pack/plugins/fleet/server/plugin.ts b/x-pack/plugins/fleet/server/plugin.ts index 51178e80260d4..ae4f6134e891f 100644 --- a/x-pack/plugins/fleet/server/plugin.ts +++ b/x-pack/plugins/fleet/server/plugin.ts @@ -67,6 +67,7 @@ import { registerSettingsRoutes, registerAppRoutes, registerPreconfigurationRoutes, + registerHealthCheckRoutes, } from './routes'; import type { ExternalCallback, FleetRequestHandlerContext } from './types'; @@ -366,6 +367,7 @@ export class FleetPlugin registerSettingsRoutes(fleetAuthzRouter); registerDataStreamRoutes(fleetAuthzRouter); registerPreconfigurationRoutes(fleetAuthzRouter); + registerHealthCheckRoutes(fleetAuthzRouter); // Conditional config routes if (config.agents.enabled) { diff --git a/x-pack/plugins/fleet/server/routes/health_check/index.ts b/x-pack/plugins/fleet/server/routes/health_check/index.ts new file mode 100644 index 0000000000000..23d917aa09a43 --- /dev/null +++ b/x-pack/plugins/fleet/server/routes/health_check/index.ts @@ -0,0 +1,34 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { APP_API_ROUTES } from '../../constants'; +import type { FleetRequestHandler } from '../../types'; +import type { FleetAuthzRouter } from '../security'; + +export const registerRoutes = (router: FleetAuthzRouter) => { + router.get( + { + path: APP_API_ROUTES.HEALTH_CHECK_PATTERN, + validate: {}, + fleetAuthz: { + fleet: { all: true }, + }, + }, + getHealthCheckHandler + ); +}; + +export const getHealthCheckHandler: FleetRequestHandler = async ( + context, + request, + response +) => { + return response.ok({ + body: 'Fleet Health Check Report:\nFleet Server: HEALTHY', + headers: { 'content-type': 'text/plain' }, + }); +}; diff --git a/x-pack/plugins/fleet/server/routes/index.ts b/x-pack/plugins/fleet/server/routes/index.ts index bcdc2db54ae0c..b04e179a05dcf 100644 --- a/x-pack/plugins/fleet/server/routes/index.ts +++ b/x-pack/plugins/fleet/server/routes/index.ts @@ -16,3 +16,4 @@ export { registerRoutes as registerOutputRoutes } from './output'; export { registerRoutes as registerSettingsRoutes } from './settings'; export { registerRoutes as registerAppRoutes } from './app'; export { registerRoutes as registerPreconfigurationRoutes } from './preconfiguration'; +export { registerRoutes as registerHealthCheckRoutes } from './health_check'; diff --git a/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts b/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts index ad46f25ff91de..c6f9e1583841b 100644 --- a/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts +++ b/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts @@ -11,7 +11,9 @@ import Boom from '@hapi/boom'; import { SavedObjectsErrorHelpers } from '@kbn/core/server'; import type { RequestHandler } from '@kbn/core/server'; -import { appContextService, packagePolicyService } from '../../services'; +import { groupBy, keyBy } from 'lodash'; + +import { agentPolicyService, appContextService, packagePolicyService } from '../../services'; import type { GetPackagePoliciesRequestSchema, GetOnePackagePolicyRequestSchema, @@ -21,6 +23,7 @@ import type { UpgradePackagePoliciesRequestSchema, DryRunPackagePoliciesRequestSchema, FleetRequestHandler, + PackagePolicy, } from '../../types'; import type { CreatePackagePolicyResponse, @@ -29,7 +32,10 @@ import type { UpgradePackagePolicyDryRunResponse, UpgradePackagePolicyResponse, } from '../../../common'; +import { installationStatuses } from '../../../common'; import { defaultIngestErrorHandler } from '../../errors'; +import { getInstallations } from '../../services/epm/packages'; +import { PACKAGES_SAVED_OBJECT_TYPE, SO_SEARCH_LIMIT } from '../../constants'; export const getPackagePoliciesHandler: RequestHandler< undefined, @@ -82,6 +88,50 @@ export const getOnePackagePolicyHandler: RequestHandler< } }; +export const getOrphanedPackagePolicies: RequestHandler = async ( + context, + request, + response +) => { + const soClient = (await context.core).savedObjects.client; + try { + const installedPackages = await getInstallations(soClient, { + perPage: SO_SEARCH_LIMIT, + filter: ` + ${PACKAGES_SAVED_OBJECT_TYPE}.attributes.install_status:${installationStatuses.Installed} + `, + }); + const orphanedPackagePolicies: PackagePolicy[] = []; + const packagePolicies = await packagePolicyService.list(soClient, { + perPage: SO_SEARCH_LIMIT, + }); + const packagePoliciesByPackage = groupBy(packagePolicies.items, 'package.name'); + const agentPolicies = await agentPolicyService.list(soClient, { + perPage: SO_SEARCH_LIMIT, + }); + const agentPoliciesById = keyBy(agentPolicies.items, 'id'); + const usedPackages = installedPackages.saved_objects.filter( + ({ attributes: { name } }) => !!packagePoliciesByPackage[name] + ); + usedPackages.forEach(({ attributes: { name } }) => { + packagePoliciesByPackage[name].forEach((packagePolicy) => { + if (!agentPoliciesById[packagePolicy.policy_id]) { + orphanedPackagePolicies.push(packagePolicy); + } + }); + }); + + return response.ok({ + body: { + items: orphanedPackagePolicies, + total: orphanedPackagePolicies.length, + }, + }); + } catch (error) { + return defaultIngestErrorHandler({ error, response }); + } +}; + export const createPackagePolicyHandler: FleetRequestHandler< undefined, undefined, @@ -218,7 +268,7 @@ export const deletePackagePolicyHandler: RequestHandler< soClient, esClient, request.body.packagePolicyIds, - { user, force: request.body.force } + { user, force: request.body.force, skipUnassignFromAgentPolicies: request.body.force } ); try { await packagePolicyService.runExternalCallbacks( diff --git a/x-pack/plugins/fleet/server/routes/package_policy/index.ts b/x-pack/plugins/fleet/server/routes/package_policy/index.ts index 68cdfc26df531..2b2ae190b80bb 100644 --- a/x-pack/plugins/fleet/server/routes/package_policy/index.ts +++ b/x-pack/plugins/fleet/server/routes/package_policy/index.ts @@ -25,6 +25,7 @@ import { deletePackagePolicyHandler, upgradePackagePolicyHandler, dryRunUpgradePackagePolicyHandler, + getOrphanedPackagePolicies, } from './handlers'; export const registerRoutes = (router: FleetAuthzRouter) => { @@ -52,6 +53,17 @@ export const registerRoutes = (router: FleetAuthzRouter) => { getOnePackagePolicyHandler ); + router.get( + { + path: PACKAGE_POLICY_API_ROUTES.ORPHANED_INTEGRATION_POLICIES, + validate: {}, + fleetAuthz: { + integrations: { readIntegrationPolicies: true }, + }, + }, + getOrphanedPackagePolicies + ); + // Create router.post( { diff --git a/x-pack/plugins/graph/public/components/field_manager/field_manager.test.tsx b/x-pack/plugins/graph/public/components/field_manager/field_manager.test.tsx index be905cd67c976..61682f0a8cc8c 100644 --- a/x-pack/plugins/graph/public/components/field_manager/field_manager.test.tsx +++ b/x-pack/plugins/graph/public/components/field_manager/field_manager.test.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { ReactElement } from 'react'; +import React, { ReactElement, MouseEvent } from 'react'; import { EuiColorPicker, EuiSelectable, EuiContextMenu, EuiButton } from '@elastic/eui'; import { FieldPicker } from './field_picker'; import { FieldEditor } from './field_editor'; @@ -98,6 +98,7 @@ describe('field_manager', () => { }); it('should select fields from picker', () => { + const event = {} as MouseEvent; expect( getInstance() .find(FieldPicker) @@ -108,9 +109,10 @@ describe('field_manager', () => { ).toEqual(['field1', 'field2', 'field3']); act(() => { - getInstance().find(FieldPicker).dive().find(EuiSelectable).prop('onChange')!([ - { checked: 'on', label: 'field3' }, - ]); + getInstance().find(FieldPicker).dive().find(EuiSelectable).prop('onChange')!( + [{ checked: 'on', label: 'field3' }], + event + ); }); expect(dispatchSpy).toHaveBeenCalledWith({ diff --git a/x-pack/plugins/index_lifecycle_management/__jest__/__snapshots__/extend_index_management.test.tsx.snap b/x-pack/plugins/index_lifecycle_management/__jest__/__snapshots__/extend_index_management.test.tsx.snap index 13888c1d1d597..582b63d5d3c97 100644 --- a/x-pack/plugins/index_lifecycle_management/__jest__/__snapshots__/extend_index_management.test.tsx.snap +++ b/x-pack/plugins/index_lifecycle_management/__jest__/__snapshots__/extend_index_management.test.tsx.snap @@ -105,7 +105,7 @@ Array [ class="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />,

-
- illegal_argument_exception: setting [index.lifecycle.rollover_alias] for index [testy3] is empty or not defined -
+ illegal_argument_exception: setting [index.lifecycle.rollover_alias] for index [testy3] is empty or not defined
,
Create your first index lifecycle policy - +
-
-
-

- An index lifecycle policy helps you manage your indices as they age. -

-
- +

+ An index lifecycle policy helps you manage your indices as they age. +

+
diff --git a/x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/data_tier_allocation.tsx b/x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/data_tier_allocation.tsx index 6ca0324d8972d..8d883cca0677b 100644 --- a/x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/data_tier_allocation.tsx +++ b/x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/data_tier_allocation_field/components/data_tier_allocation.tsx @@ -121,9 +121,7 @@ const getSelectOptions = (phase: PhaseWithAllocation, disableDataTierOption: boo <> {i18nTexts.allocationOptions[phase].default.input} -

- {i18nTexts.allocationOptions[phase].default.helpText} -

+

{i18nTexts.allocationOptions[phase].default.helpText}

 ), @@ -136,9 +134,7 @@ const getSelectOptions = (phase: PhaseWithAllocation, disableDataTierOption: boo <> {i18nTexts.allocationOptions[phase].custom.inputDisplay} -

- {i18nTexts.allocationOptions[phase].custom.helpText} -

+

{i18nTexts.allocationOptions[phase].custom.helpText}

 ), @@ -151,9 +147,7 @@ const getSelectOptions = (phase: PhaseWithAllocation, disableDataTierOption: boo <> {i18nTexts.allocationOptions[phase].none.inputDisplay} -

- {i18nTexts.allocationOptions[phase].none.helpText} -

+

{i18nTexts.allocationOptions[phase].none.helpText}

 ), diff --git a/x-pack/plugins/index_lifecycle_management/public/extend_index_management/components/index_lifecycle_summary.tsx b/x-pack/plugins/index_lifecycle_management/public/extend_index_management/components/index_lifecycle_summary.tsx index af3f16216813b..91b9203bea1aa 100644 --- a/x-pack/plugins/index_lifecycle_management/public/extend_index_management/components/index_lifecycle_summary.tsx +++ b/x-pack/plugins/index_lifecycle_management/public/extend_index_management/components/index_lifecycle_summary.tsx @@ -140,7 +140,9 @@ export class IndexLifecycleSummary extends Component { id="xpack.indexLifecycleMgmt.indexLifecycleMgmtSummary.phaseDefinitionTitle" /> - {JSON.stringify(ilm.phase_execution, null, 2)} + + {JSON.stringify(ilm.phase_execution, null, 2)} + diff --git a/x-pack/plugins/index_management/public/application/components/component_templates/component_template_details/tab_summary.tsx b/x-pack/plugins/index_management/public/application/components/component_templates/component_template_details/tab_summary.tsx index edba90affee70..3e9f0c38f2a52 100644 --- a/x-pack/plugins/index_management/public/application/components/component_templates/component_template_details/tab_summary.tsx +++ b/x-pack/plugins/index_management/public/application/components/component_templates/component_template_details/tab_summary.tsx @@ -141,7 +141,7 @@ export const TabSummary: React.FunctionComponent = ({ /> - {JSON.stringify(_meta, null, 2)} + {JSON.stringify(_meta, null, 2)} )} diff --git a/x-pack/plugins/index_management/public/application/components/index_templates/simulate_template/simulate_template.tsx b/x-pack/plugins/index_management/public/application/components/index_templates/simulate_template/simulate_template.tsx index 325ef03227826..f0d34c0df6be1 100644 --- a/x-pack/plugins/index_management/public/application/components/index_templates/simulate_template/simulate_template.tsx +++ b/x-pack/plugins/index_management/public/application/components/index_templates/simulate_template/simulate_template.tsx @@ -90,7 +90,7 @@ export const SimulateTemplate = React.memo(({ template, filters }: Props) => { } return isEmpty ? null : ( - + {templatePreview} ); diff --git a/x-pack/plugins/index_management/public/application/components/mappings_editor/constants/field_options.tsx b/x-pack/plugins/index_management/public/application/components/mappings_editor/constants/field_options.tsx index 1bd7dcb004fdc..ec6b3e9cabd34 100644 --- a/x-pack/plugins/index_management/public/application/components/mappings_editor/constants/field_options.tsx +++ b/x-pack/plugins/index_management/public/application/components/mappings_editor/constants/field_options.tsx @@ -43,7 +43,7 @@ export const getSuperSelectOption = ( <> {title} -

{description}

+

{description}

 ), diff --git a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_aliases.tsx b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_aliases.tsx index c02404596dcc5..fd11be88ec1c1 100644 --- a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_aliases.tsx +++ b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_aliases.tsx @@ -19,7 +19,7 @@ export const TabAliases: React.FunctionComponent = ({ aliases }) => { if (aliases && Object.keys(aliases).length) { return (
- + {JSON.stringify(aliases, null, 2)}
diff --git a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_mappings.tsx b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_mappings.tsx index 0ed22589f8f3d..87da0453bbb5e 100644 --- a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_mappings.tsx +++ b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_mappings.tsx @@ -18,7 +18,7 @@ export const TabMappings: React.FunctionComponent = ({ mappings }) => { if (mappings && Object.keys(mappings).length) { return (
- + {JSON.stringify(mappings, null, 2)}
diff --git a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_settings.tsx b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_settings.tsx index 915adb6cf849a..5f1d70df863b6 100644 --- a/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_settings.tsx +++ b/x-pack/plugins/index_management/public/application/components/shared/components/details_panel/tab_settings.tsx @@ -18,7 +18,7 @@ export const TabSettings: React.FunctionComponent = ({ settings }) => { if (settings && Object.keys(settings).length) { return (
- + {JSON.stringify(settings, null, 2)}
diff --git a/x-pack/plugins/index_management/public/application/components/template_form/steps/step_review.tsx b/x-pack/plugins/index_management/public/application/components/template_form/steps/step_review.tsx index b46105be11e5f..3d7b88eeb0c45 100644 --- a/x-pack/plugins/index_management/public/application/components/template_form/steps/step_review.tsx +++ b/x-pack/plugins/index_management/public/application/components/template_form/steps/step_review.tsx @@ -268,7 +268,7 @@ export const StepReview: React.FunctionComponent = React.memo( /> - {JSON.stringify(_meta, null, 2)} + {JSON.stringify(_meta, null, 2)} )} diff --git a/x-pack/plugins/index_management/public/application/sections/home/index_list/detail_panel/show_json/show_json.js b/x-pack/plugins/index_management/public/application/sections/home/index_list/detail_panel/show_json/show_json.js index b7874ee12ec8c..6ad472e695936 100644 --- a/x-pack/plugins/index_management/public/application/sections/home/index_list/detail_panel/show_json/show_json.js +++ b/x-pack/plugins/index_management/public/application/sections/home/index_list/detail_panel/show_json/show_json.js @@ -26,6 +26,6 @@ export class ShowJson extends React.PureComponent { return null; } const json = JSON.stringify(data, null, 2); - return {json}; + return {json}; } } diff --git a/x-pack/plugins/index_management/public/application/sections/home/template_list/template_details/tabs/tab_summary.tsx b/x-pack/plugins/index_management/public/application/sections/home/template_list/template_details/tabs/tab_summary.tsx index b4edeefbae8cf..20a7c172d674b 100644 --- a/x-pack/plugins/index_management/public/application/sections/home/template_list/template_details/tabs/tab_summary.tsx +++ b/x-pack/plugins/index_management/public/application/sections/home/template_list/template_details/tabs/tab_summary.tsx @@ -209,7 +209,7 @@ export const TabSummary: React.FunctionComponent = ({ templateDetails }) /> - {JSON.stringify(_meta, null, 2)} + {JSON.stringify(_meta, null, 2)} )} diff --git a/x-pack/plugins/infra/public/alerting/inventory/components/expression.test.tsx b/x-pack/plugins/infra/public/alerting/inventory/components/expression.test.tsx index 591014472d81a..8ce04586c74b6 100644 --- a/x-pack/plugins/infra/public/alerting/inventory/components/expression.test.tsx +++ b/x-pack/plugins/infra/public/alerting/inventory/components/expression.test.tsx @@ -207,8 +207,11 @@ describe('ExpressionRow', () => { it('loads custom metrics passed in through the expression, even with an empty context', async () => { const { wrapper } = await setup(expression as InventoryMetricConditions); const [valueMatch] = - wrapper.html().match('Rate of some.system.field') ?? - []; + wrapper + .html() + .match( + 'Rate of some.system.field' + ) ?? []; expect(valueMatch).toBeTruthy(); }); }); diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.test.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.test.tsx index 6a0de2481e64a..a023270e65702 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.test.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.test.tsx @@ -76,7 +76,11 @@ describe('ExpressionRow', () => { }; const { wrapper, update } = await setup(expression as MetricExpression); await update(); - const [valueMatch] = wrapper.html().match('50') ?? []; + const [valueMatch] = + wrapper + .html() + .match('50') ?? + []; expect(valueMatch).toBeTruthy(); }); @@ -91,7 +95,10 @@ describe('ExpressionRow', () => { }; const { wrapper } = await setup(expression as MetricExpression); const [valueMatch] = - wrapper.html().match('0.5') ?? []; + wrapper + .html() + .match('0.5') ?? + []; expect(valueMatch).toBeTruthy(); }); diff --git a/x-pack/plugins/infra/public/components/empty_states/index.tsx b/x-pack/plugins/infra/public/components/empty_states/index.tsx index d1b3d375a4779..27c0ea44a2491 100644 --- a/x-pack/plugins/infra/public/components/empty_states/index.tsx +++ b/x-pack/plugins/infra/public/components/empty_states/index.tsx @@ -5,5 +5,6 @@ * 2.0. */ -export { NoIndices } from './no_indices'; +export * from './no_metric_indices'; export { NoData } from './no_data'; +export { NoIndices } from './no_indices'; diff --git a/x-pack/plugins/infra/public/components/empty_states/no_metric_indices.tsx b/x-pack/plugins/infra/public/components/empty_states/no_metric_indices.tsx new file mode 100644 index 0000000000000..433f4caaa4b6a --- /dev/null +++ b/x-pack/plugins/infra/public/components/empty_states/no_metric_indices.tsx @@ -0,0 +1,28 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const noMetricIndicesPromptPrimaryActionTitle = i18n.translate( + 'xpack.infra.metrics.noDataConfig.beatsCard.title', + { + defaultMessage: 'Add a metrics integration', + } +); + +export const noMetricIndicesPromptDescription = i18n.translate( + 'xpack.infra.metrics.noDataConfig.beatsCard.description', + { + defaultMessage: + 'Use Beats to send metrics data to Elasticsearch. We make it easy with modules for many popular systems and apps.', + } +); + +export const noMetricIndicesPromptTitle = i18n.translate( + 'xpack.infra.metrics.noDataConfig.promptTitle', + { defaultMessage: 'Add metrics data' } +); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.stories.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.stories.tsx index 9b4d3938e7d4c..56c9f75483abc 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.stories.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.stories.tsx @@ -7,12 +7,13 @@ import { EuiCard } from '@elastic/eui'; import { I18nProvider } from '@kbn/i18n-react'; -import type { Meta } from '@storybook/react/types-6-0'; -import React from 'react'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import type { Meta, Story } from '@storybook/react/types-6-0'; +import React from 'react'; import { decorateWithGlobalStorybookThemeProviders } from '../../../test_utils/use_global_storybook_theme'; -import { ContainerMetricsTable } from './container_metrics_table'; import type { ContainerMetricsTableProps } from './container_metrics_table'; +import { ContainerMetricsTable } from './container_metrics_table'; +import { ContainerNodeMetricsRow } from './use_container_metrics_table'; const mockServices = { application: { @@ -32,6 +33,20 @@ export default { decorateWithGlobalStorybookThemeProviders, ], component: ContainerMetricsTable, + args: { + data: { + state: 'empty-indices', + }, + isLoading: false, + sortState: { + direction: 'desc', + field: 'averageCpuUsagePercent', + }, + timerange: { + from: 'now-15m', + to: 'now', + }, + }, argTypes: { setSortState: { action: 'Sort field or direction changed', @@ -42,53 +57,95 @@ export default { }, } as Meta; -const storyArgs: Omit = { - isLoading: false, - containers: [ - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', - uptime: 23000000, - averageCpuUsagePercent: 99, - averageMemoryUsageMegabytes: 34, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', - uptime: 43000000, - averageCpuUsagePercent: 72, - averageMemoryUsageMegabytes: 68, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', - uptime: 53000000, - averageCpuUsagePercent: 54, - averageMemoryUsageMegabytes: 132, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', - uptime: 63000000, - averageCpuUsagePercent: 34, - averageMemoryUsageMegabytes: 264, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', - uptime: 83000000, - averageCpuUsagePercent: 13, - averageMemoryUsageMegabytes: 512, - }, - ], - currentPageIndex: 0, - pageCount: 10, - sortState: { - direction: 'desc', - field: 'averageCpuUsagePercent', +const loadedContainers: ContainerNodeMetricsRow[] = [ + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', + uptime: 23000000, + averageCpuUsagePercent: 99, + averageMemoryUsageMegabytes: 34, }, - timerange: { - from: 'now-15m', - to: 'now', + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', + uptime: 43000000, + averageCpuUsagePercent: 72, + averageMemoryUsageMegabytes: 68, }, -}; + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', + uptime: 53000000, + averageCpuUsagePercent: 54, + averageMemoryUsageMegabytes: 132, + }, + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', + uptime: 63000000, + averageCpuUsagePercent: 34, + averageMemoryUsageMegabytes: 264, + }, + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', + uptime: 83000000, + averageCpuUsagePercent: 13, + averageMemoryUsageMegabytes: 512, + }, +]; -export const Demo = (args: ContainerMetricsTableProps) => { +const Template: Story = (args) => { return ; }; -Demo.args = storyArgs; + +export const Basic = Template.bind({}); +Basic.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedContainers, + }, +}; + +export const Loading = Template.bind({}); +Loading.args = { + isLoading: true, +}; + +export const Reloading = Template.bind({}); +Reloading.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedContainers, + }, + isLoading: true, +}; + +export const MissingIndices = Template.bind({}); +MissingIndices.args = { + data: { + state: 'no-indices', + }, +}; + +export const EmptyIndices = Template.bind({}); +EmptyIndices.args = { + data: { + state: 'empty-indices', + }, +}; + +export const FailedToLoadSource = Template.bind({}); +FailedToLoadSource.args = { + data: { + state: 'error', + errors: [new Error('Failed to load source configuration')], + }, +}; + +export const FailedToLoadMetrics = Template.bind({}); +FailedToLoadMetrics.args = { + data: { + state: 'error', + errors: [new Error('Failed to load metrics')], + }, +}; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx index 4ead102c9bae8..2f35fe2b0c90e 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.test.tsx @@ -5,19 +5,21 @@ * 2.0. */ +import type { HttpFetchOptions } from '@kbn/core/public'; +import { MetricsExplorerSeries } from '../../../../common/http_api'; +import { CoreProviders } from '../../../apps/common_providers'; import { render, screen, waitFor } from '@testing-library/react'; import React from 'react'; -import type { HttpFetchOptions } from '@kbn/core/public'; import type { DataResponseMock, NodeMetricsTableFetchMock, SourceResponseMock, } from '../test_helpers'; import { createStartServicesAccessorMock } from '../test_helpers'; +import { ContainerMetricsTable } from './container_metrics_table'; import { createLazyContainerMetricsTable } from './create_lazy_container_metrics_table'; import IntegratedContainerMetricsTable from './integrated_container_metrics_table'; import { metricByField } from './use_container_metrics_table'; -import type { MetricsExplorerSeries } from '../../../../common/http_api'; describe('ContainerMetricsTable', () => { const timerange = { @@ -40,6 +42,8 @@ describe('ContainerMetricsTable', () => { const fetchMock = createFetchMock(); + const loadingIndicatorTestId = 'metricsTableLoadingContent'; + describe('createLazyContainerMetricsTable', () => { it('should lazily load and render the table', async () => { const { fetch, getStartServices } = createStartServicesAccessorMock(fetchMock); @@ -47,7 +51,7 @@ describe('ContainerMetricsTable', () => { render(); - expect(screen.queryByTestId('containerMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('containerMetricsTable')).not.toBeInTheDocument(); // Using longer time out since resolving dynamic import can be slow @@ -56,7 +60,7 @@ describe('ContainerMetricsTable', () => { timeout: 10000, }); - expect(screen.queryByTestId('containerMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('containerMetricsTable')).toBeInTheDocument(); }, 10000); }); @@ -79,6 +83,44 @@ describe('ContainerMetricsTable', () => { expect(await findByText(/some-container/)).toBeInTheDocument(); }); }); + + it('should render a loading indicator on first load', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId(loadingIndicatorTestId)).toBeInTheDocument(); + }); + + it('should render a prompt when indices are missing', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId('metricsTableLoadingContent')).toBeInTheDocument(); + }); }); function createFetchMock(): NodeMetricsTableFetchMock { @@ -87,6 +129,9 @@ function createFetchMock(): NodeMetricsTableFetchMock { configuration: { metricAlias: 'some-index-pattern', }, + status: { + metricIndicesExist: true, + }, }, }; @@ -97,7 +142,7 @@ function createFetchMock(): NodeMetricsTableFetchMock { ], }; - return (path: string, options: HttpFetchOptions) => { + return (path: string, _options: HttpFetchOptions) => { // options can be used to read body for filter clause if (path === '/api/metrics/source/default') { return Promise.resolve(sourceMock); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx index 445bfd7c107fb..6c75bf1e2d16b 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/container_metrics_table.tsx @@ -10,44 +10,37 @@ import type { EuiBasicTableColumn, EuiTableSortingType, } from '@elastic/eui'; -import { - EuiBasicTable, - EuiFlexGroup, - EuiFlexItem, - EuiLoadingSpinner, - EuiSpacer, -} from '@elastic/eui'; +import { EuiBasicTable, EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React, { useCallback, useMemo } from 'react'; import type { SortState } from '../shared'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; +import { + MetricsNodeDetailsLink, + MetricsTableEmptyIndicesContent, + MetricsTableErrorContent, + MetricsTableLoadingContent, + MetricsTableNoIndicesContent, + NodeMetricsTableData, + NumberCell, + StepwisePagination, + UptimeCell, +} from '../shared'; import type { ContainerNodeMetricsRow } from './use_container_metrics_table'; export interface ContainerMetricsTableProps { + data: NodeMetricsTableData; + isLoading: boolean; + setCurrentPageIndex: (value: number) => void; + setSortState: (state: SortState) => void; + sortState: SortState; timerange: { from: string; to: string; }; - isLoading: boolean; - containers: ContainerNodeMetricsRow[]; - pageCount: number; - currentPageIndex: number; - setCurrentPageIndex: (value: number) => void; - sortState: SortState; - setSortState: (state: SortState) => void; } export const ContainerMetricsTable = (props: ContainerMetricsTableProps) => { - const { - timerange, - isLoading, - containers, - pageCount, - currentPageIndex, - setCurrentPageIndex, - sortState, - setSortState, - } = props; + const { data, isLoading, setCurrentPageIndex, setSortState, sortState, timerange } = props; const columns = useMemo(() => containerNodeColumns(timerange), [timerange]); @@ -68,42 +61,54 @@ export const ContainerMetricsTable = (props: ContainerMetricsTableProps) => { [setSortState, setCurrentPageIndex] ); - if (isLoading) { + if (data.state === 'error') { + return ( + <> + {data.errors.map((error) => ( + + ))} + + ); + } else if (isLoading && data.state !== 'data') { + return ; + } else if (data.state === 'no-indices') { + return ; + } else if (data.state === 'empty-indices') { + return ; + } else if (data.state === 'data') { return ( - - - + <> + } + data-test-subj="containerMetricsTable" + /> + + + + + + + ); + } else { + return null; } - - return ( - <> - - - - - - - - - ); }; function containerNodeColumns( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts index 6fea0b399b425..946aa2dac6c7e 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/container/use_container_metrics_table.ts @@ -73,11 +73,7 @@ export function useContainerMetricsTable({ [filterClauseDsl] ); - const { - isLoading, - nodes: containers, - pageCount, - } = useInfrastructureNodeMetrics({ + const { data, isLoading } = useInfrastructureNodeMetrics({ metricsExplorerOptions: containerMetricsOptions, timerange, transform: seriesToContainerNodeMetricsRow, @@ -86,14 +82,12 @@ export function useContainerMetricsTable({ }); return { - timerange, + data, isLoading, - containers, - pageCount, - currentPageIndex, setCurrentPageIndex, - sortState, setSortState, + sortState, + timerange, }; } diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.stories.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.stories.tsx index 862d55a45c094..657ed19f0c0cb 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.stories.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.stories.tsx @@ -7,12 +7,13 @@ import { EuiCard } from '@elastic/eui'; import { I18nProvider } from '@kbn/i18n-react'; -import type { Meta } from '@storybook/react/types-6-0'; -import React from 'react'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import type { Meta, Story } from '@storybook/react/types-6-0'; +import React from 'react'; import { decorateWithGlobalStorybookThemeProviders } from '../../../test_utils/use_global_storybook_theme'; -import { HostMetricsTable } from './host_metrics_table'; import type { HostMetricsTableProps } from './host_metrics_table'; +import { HostMetricsTable } from './host_metrics_table'; +import { HostNodeMetricsRow } from './use_host_metrics_table'; const mockServices = { application: { @@ -32,6 +33,20 @@ export default { decorateWithGlobalStorybookThemeProviders, ], component: HostMetricsTable, + args: { + data: { + state: 'empty-indices', + }, + isLoading: false, + sortState: { + direction: 'desc', + field: 'averageCpuUsagePercent', + }, + timerange: { + from: 'now-15m', + to: 'now', + }, + }, argTypes: { setSortState: { action: 'Sort field or direction changed', @@ -40,60 +55,102 @@ export default { action: 'Page changed', }, }, -} as Meta; +} as Meta; -const storyArgs: Omit = { - isLoading: false, - hosts: [ - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', - cpuCount: 2, - averageCpuUsagePercent: 99, - totalMemoryMegabytes: 1024, - averageMemoryUsagePercent: 34, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', - cpuCount: 4, - averageCpuUsagePercent: 74, - totalMemoryMegabytes: 2450, - averageMemoryUsagePercent: 13, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', - cpuCount: 8, - averageCpuUsagePercent: 56, - totalMemoryMegabytes: 4810, - averageMemoryUsagePercent: 74, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', - cpuCount: 16, - averageCpuUsagePercent: 34, - totalMemoryMegabytes: 8123, - averageMemoryUsagePercent: 56, - }, - { - name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', - cpuCount: 32, - averageCpuUsagePercent: 13, - totalMemoryMegabytes: 16792, - averageMemoryUsagePercent: 99, - }, - ], - currentPageIndex: 0, - pageCount: 10, - sortState: { - direction: 'desc', - field: 'averageCpuUsagePercent', +const loadedHosts: HostNodeMetricsRow[] = [ + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', + cpuCount: 2, + averageCpuUsagePercent: 99, + totalMemoryMegabytes: 1024, + averageMemoryUsagePercent: 34, }, - timerange: { - from: 'now-15m', - to: 'now', + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', + cpuCount: 4, + averageCpuUsagePercent: 74, + totalMemoryMegabytes: 2450, + averageMemoryUsagePercent: 13, }, -}; + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', + cpuCount: 8, + averageCpuUsagePercent: 56, + totalMemoryMegabytes: 4810, + averageMemoryUsagePercent: 74, + }, + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', + cpuCount: 16, + averageCpuUsagePercent: 34, + totalMemoryMegabytes: 8123, + averageMemoryUsagePercent: 56, + }, + { + name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', + cpuCount: 32, + averageCpuUsagePercent: 13, + totalMemoryMegabytes: 16792, + averageMemoryUsagePercent: 99, + }, +]; -export const Demo = (args: HostMetricsTableProps) => { +const Template: Story = (args) => { return ; }; -Demo.args = storyArgs; + +export const Basic = Template.bind({}); +Basic.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedHosts, + }, +}; + +export const Loading = Template.bind({}); +Loading.args = { + isLoading: true, +}; + +export const Reloading = Template.bind({}); +Reloading.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedHosts, + }, + isLoading: true, +}; + +export const MissingIndices = Template.bind({}); +MissingIndices.args = { + data: { + state: 'no-indices', + }, +}; + +export const EmptyIndices = Template.bind({}); +EmptyIndices.args = { + data: { + state: 'empty-indices', + }, +}; + +export const FailedToLoadSource = Template.bind({}); +FailedToLoadSource.args = { + data: { + state: 'error', + errors: [new Error('Failed to load source configuration')], + }, +}; + +export const FailedToLoadMetrics = Template.bind({}); +FailedToLoadMetrics.args = { + data: { + state: 'error', + errors: [new Error('Failed to load metrics')], + }, +}; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.test.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.test.tsx index 892972a077835..970ec38707b16 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.test.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.test.tsx @@ -5,9 +5,11 @@ * 2.0. */ +import type { HttpFetchOptions } from '@kbn/core/public'; +import { CoreProviders } from '../../../apps/common_providers'; import { render, screen, waitFor } from '@testing-library/react'; import React from 'react'; -import type { HttpFetchOptions } from '@kbn/core/public'; +import type { MetricsExplorerSeries } from '../../../../common/http_api'; import type { DataResponseMock, NodeMetricsTableFetchMock, @@ -15,9 +17,9 @@ import type { } from '../test_helpers'; import { createStartServicesAccessorMock } from '../test_helpers'; import { createLazyHostMetricsTable } from './create_lazy_host_metrics_table'; +import { HostMetricsTable } from './host_metrics_table'; import IntegratedHostMetricsTable from './integrated_host_metrics_table'; import { metricByField } from './use_host_metrics_table'; -import type { MetricsExplorerSeries } from '../../../../common/http_api'; describe('HostMetricsTable', () => { const timerange = { @@ -40,6 +42,8 @@ describe('HostMetricsTable', () => { const fetchMock = createFetchMock(); + const loadingIndicatorTestId = 'metricsTableLoadingContent'; + describe('createLazyHostMetricsTable', () => { it('should lazily load and render the table', async () => { const { fetch, getStartServices } = createStartServicesAccessorMock(fetchMock); @@ -47,7 +51,7 @@ describe('HostMetricsTable', () => { render(); - expect(screen.queryByTestId('hostMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('hostMetricsTable')).not.toBeInTheDocument(); // Using longer time out since resolving dynamic import can be slow @@ -56,7 +60,7 @@ describe('HostMetricsTable', () => { timeout: 10000, }); - expect(screen.queryByTestId('hostMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('hostMetricsTable')).toBeInTheDocument(); }, 10000); }); @@ -79,6 +83,44 @@ describe('HostMetricsTable', () => { expect(await findByText(/some-host/)).toBeInTheDocument(); }); }); + + it('should render a loading indicator on first load', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId(loadingIndicatorTestId)).toBeInTheDocument(); + }); + + it('should render a prompt when indices are missing', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId('metricsTableLoadingContent')).toBeInTheDocument(); + }); }); function createFetchMock(): NodeMetricsTableFetchMock { @@ -87,6 +129,9 @@ function createFetchMock(): NodeMetricsTableFetchMock { configuration: { metricAlias: 'some-index-pattern', }, + status: { + metricIndicesExist: true, + }, }, }; @@ -97,7 +142,7 @@ function createFetchMock(): NodeMetricsTableFetchMock { ], }; - return (path: string, options: HttpFetchOptions) => { + return (path: string, _options: HttpFetchOptions) => { // options can be used to read body for filter clause if (path === '/api/metrics/source/default') { return Promise.resolve(sourceMock); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx index 043d9411bf284..53e3576a732b0 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/host_metrics_table.tsx @@ -10,44 +10,36 @@ import type { EuiBasicTableColumn, EuiTableSortingType, } from '@elastic/eui'; -import { - EuiBasicTable, - EuiFlexGroup, - EuiFlexItem, - EuiLoadingSpinner, - EuiSpacer, -} from '@elastic/eui'; +import { EuiBasicTable, EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React, { useCallback, useMemo } from 'react'; import type { SortState } from '../shared'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination } from '../shared'; +import { + MetricsNodeDetailsLink, + MetricsTableEmptyIndicesContent, + MetricsTableErrorContent, + MetricsTableLoadingContent, + MetricsTableNoIndicesContent, + NodeMetricsTableData, + NumberCell, + StepwisePagination, +} from '../shared'; import type { HostNodeMetricsRow } from './use_host_metrics_table'; export interface HostMetricsTableProps { + data: NodeMetricsTableData; + isLoading: boolean; + setCurrentPageIndex: (value: number) => void; + setSortState: (state: SortState) => void; + sortState: SortState; timerange: { from: string; to: string; }; - isLoading: boolean; - hosts: HostNodeMetricsRow[]; - pageCount: number; - currentPageIndex: number; - setCurrentPageIndex: (value: number) => void; - sortState: SortState; - setSortState: (state: SortState) => void; } export const HostMetricsTable = (props: HostMetricsTableProps) => { - const { - timerange, - isLoading, - hosts, - pageCount, - currentPageIndex, - setCurrentPageIndex, - sortState, - setSortState, - } = props; + const { data, isLoading, setCurrentPageIndex, setSortState, sortState, timerange } = props; const columns = useMemo(() => hostMetricsColumns(timerange), [timerange]); @@ -68,42 +60,54 @@ export const HostMetricsTable = (props: HostMetricsTableProps) => { [setSortState, setCurrentPageIndex] ); - if (isLoading) { + if (data.state === 'error') { return ( - - - + <> + {data.errors.map((error) => ( + + ))} + ); + } else if (isLoading && data.state !== 'data') { + return ; + } else if (data.state === 'no-indices') { + return ; + } else if (data.state === 'empty-indices') { + return ; + } else if (data.state === 'data') { + return ( + <> + } + data-test-subj="hostMetricsTable" + /> + + + + + + + + ); + } else { + return null; } - - return ( - <> - - - - - - - - - ); }; function hostMetricsColumns( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts index 602b5e519d25d..9492df0b533e6 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/host/use_host_metrics_table.ts @@ -70,11 +70,7 @@ export function useHostMetricsTable({ timerange, filterClauseDsl }: UseNodeMetri [filterClauseDsl] ); - const { - isLoading, - nodes: hosts, - pageCount, - } = useInfrastructureNodeMetrics({ + const { data, isLoading } = useInfrastructureNodeMetrics({ metricsExplorerOptions: hostMetricsOptions, timerange, transform: seriesToHostNodeMetricsRow, @@ -83,14 +79,12 @@ export function useHostMetricsTable({ timerange, filterClauseDsl }: UseNodeMetri }); return { - timerange, + data, isLoading, - hosts, - pageCount, - currentPageIndex, setCurrentPageIndex, - sortState, setSortState, + sortState, + timerange, }; } diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.stories.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.stories.tsx index 79b1f0d55f92c..eb6057d88d04e 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.stories.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.stories.tsx @@ -7,12 +7,13 @@ import { EuiCard } from '@elastic/eui'; import { I18nProvider } from '@kbn/i18n-react'; -import type { Meta } from '@storybook/react/types-6-0'; -import React from 'react'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import type { Meta, Story } from '@storybook/react/types-6-0'; +import React from 'react'; import { decorateWithGlobalStorybookThemeProviders } from '../../../test_utils/use_global_storybook_theme'; -import { PodMetricsTable } from './pod_metrics_table'; import type { PodMetricsTableProps } from './pod_metrics_table'; +import { PodMetricsTable } from './pod_metrics_table'; +import { PodNodeMetricsRow } from './use_pod_metrics_table'; const mockServices = { application: { @@ -32,6 +33,20 @@ export default { decorateWithGlobalStorybookThemeProviders, ], component: PodMetricsTable, + args: { + data: { + state: 'empty-indices', + }, + isLoading: false, + sortState: { + direction: 'desc', + field: 'averageCpuUsagePercent', + }, + timerange: { + from: 'now-15m', + to: 'now', + }, + }, argTypes: { setSortState: { action: 'Sort field or direction changed', @@ -42,58 +57,100 @@ export default { }, } as Meta; -const storyArgs: Omit = { - isLoading: false, - pods: [ - { - id: '358d96e3-026f-4440-a487-f6c2301884c0', - name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', - uptime: 23000000, - averageCpuUsagePercent: 99, - averageMemoryUsageMegabytes: 34, - }, - { - id: '358d96e3-026f-4440-a487-f6c2301884c1', - name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', - uptime: 43000000, - averageCpuUsagePercent: 72, - averageMemoryUsageMegabytes: 68, - }, - { - id: '358d96e3-026f-4440-a487-f6c2301884c0', - name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', - uptime: 53000000, - averageCpuUsagePercent: 54, - averageMemoryUsageMegabytes: 132, - }, - { - id: '358d96e3-026f-4440-a487-f6c2301884c0', - name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', - uptime: 63000000, - averageCpuUsagePercent: 34, - averageMemoryUsageMegabytes: 264, - }, - { - id: '358d96e3-026f-4440-a487-f6c2301884c0', - name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', - uptime: 83000000, - averageCpuUsagePercent: 13, - averageMemoryUsageMegabytes: 512, - }, - ], - currentPageIndex: 0, - pageCount: 10, - sortState: { - direction: 'desc', - field: 'averageCpuUsagePercent', +const loadedPods: PodNodeMetricsRow[] = [ + { + id: '358d96e3-026f-4440-a487-f6c2301884c0', + name: 'gke-edge-oblt-pool-1-9a60016d-lgg1', + uptime: 23000000, + averageCpuUsagePercent: 99, + averageMemoryUsageMegabytes: 34, }, - timerange: { - from: 'now-15m', - to: 'now', + { + id: '358d96e3-026f-4440-a487-f6c2301884c1', + name: 'gke-edge-oblt-pool-1-9a60016d-lgg2', + uptime: 43000000, + averageCpuUsagePercent: 72, + averageMemoryUsageMegabytes: 68, }, -}; + { + id: '358d96e3-026f-4440-a487-f6c2301884c0', + name: 'gke-edge-oblt-pool-1-9a60016d-lgg3', + uptime: 53000000, + averageCpuUsagePercent: 54, + averageMemoryUsageMegabytes: 132, + }, + { + id: '358d96e3-026f-4440-a487-f6c2301884c0', + name: 'gke-edge-oblt-pool-1-9a60016d-lgg4', + uptime: 63000000, + averageCpuUsagePercent: 34, + averageMemoryUsageMegabytes: 264, + }, + { + id: '358d96e3-026f-4440-a487-f6c2301884c0', + name: 'gke-edge-oblt-pool-1-9a60016d-lgg5', + uptime: 83000000, + averageCpuUsagePercent: 13, + averageMemoryUsageMegabytes: 512, + }, +]; -export const Demo = (args: PodMetricsTableProps) => { +const Template: Story = (args) => { return ; }; -Demo.args = storyArgs; + +export const Basic = Template.bind({}); +Basic.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedPods, + }, +}; + +export const Loading = Template.bind({}); +Loading.args = { + isLoading: true, +}; + +export const Reloading = Template.bind({}); +Reloading.args = { + data: { + state: 'data', + currentPageIndex: 1, + pageCount: 10, + rows: loadedPods, + }, + isLoading: true, +}; + +export const MissingIndices = Template.bind({}); +MissingIndices.args = { + data: { + state: 'no-indices', + }, +}; + +export const EmptyIndices = Template.bind({}); +EmptyIndices.args = { + data: { + state: 'empty-indices', + }, +}; + +export const FailedToLoadSource = Template.bind({}); +FailedToLoadSource.args = { + data: { + state: 'error', + errors: [new Error('Failed to load source configuration')], + }, +}; + +export const FailedToLoadMetrics = Template.bind({}); +FailedToLoadMetrics.args = { + data: { + state: 'error', + errors: [new Error('Failed to load metrics')], + }, +}; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx index bc3b7199ecd5d..aba60015d2633 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.test.tsx @@ -5,9 +5,11 @@ * 2.0. */ +import type { HttpFetchOptions } from '@kbn/core/public'; +import { CoreProviders } from '../../../apps/common_providers'; import { render, screen, waitFor } from '@testing-library/react'; import React from 'react'; -import type { HttpFetchOptions } from '@kbn/core/public'; +import type { MetricsExplorerSeries } from '../../../../common/http_api'; import type { DataResponseMock, NodeMetricsTableFetchMock, @@ -16,8 +18,8 @@ import type { import { createStartServicesAccessorMock } from '../test_helpers'; import { createLazyPodMetricsTable } from './create_lazy_pod_metrics_table'; import IntegratedPodMetricsTable from './integrated_pod_metrics_table'; +import { PodMetricsTable } from './pod_metrics_table'; import { metricByField } from './use_pod_metrics_table'; -import type { MetricsExplorerSeries } from '../../../../common/http_api'; describe('PodMetricsTable', () => { const timerange = { @@ -40,6 +42,8 @@ describe('PodMetricsTable', () => { const fetchMock = createFetchMock(); + const loadingIndicatorTestId = 'metricsTableLoadingContent'; + describe('createLazyPodMetricsTable', () => { it('should lazily load and render the table', async () => { const { fetch, getStartServices } = createStartServicesAccessorMock(fetchMock); @@ -47,7 +51,7 @@ describe('PodMetricsTable', () => { render(); - expect(screen.queryByTestId('podMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('podMetricsTable')).not.toBeInTheDocument(); // Using longer time out since resolving dynamic import can be slow @@ -56,7 +60,7 @@ describe('PodMetricsTable', () => { timeout: 10000, }); - expect(screen.queryByTestId('podMetricsTableLoader')).not.toBeInTheDocument(); + expect(screen.queryByTestId(loadingIndicatorTestId)).not.toBeInTheDocument(); expect(screen.queryByTestId('podMetricsTable')).toBeInTheDocument(); }, 10000); }); @@ -79,6 +83,44 @@ describe('PodMetricsTable', () => { expect(await findByText(/some-pod/)).toBeInTheDocument(); }); }); + + it('should render a loading indicator on first load', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId(loadingIndicatorTestId)).toBeInTheDocument(); + }); + + it('should render a prompt when indices are missing', () => { + const { coreProvidersPropsMock } = createStartServicesAccessorMock(jest.fn()); + + const { queryByTestId } = render( + + + + ); + + expect(queryByTestId('metricsTableLoadingContent')).toBeInTheDocument(); + }); }); function createFetchMock(): NodeMetricsTableFetchMock { @@ -87,6 +129,9 @@ function createFetchMock(): NodeMetricsTableFetchMock { configuration: { metricAlias: 'some-index-pattern', }, + status: { + metricIndicesExist: true, + }, }, }; @@ -97,7 +142,7 @@ function createFetchMock(): NodeMetricsTableFetchMock { ], }; - return (path: string, options: HttpFetchOptions) => { + return (path: string, _options: HttpFetchOptions) => { // options can be used to read body for filter clause if (path === '/api/metrics/source/default') { return Promise.resolve(sourceMock); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx index 9e8016ac1c2ef..7021371b63245 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/pod_metrics_table.tsx @@ -10,44 +10,37 @@ import type { EuiBasicTableColumn, EuiTableSortingType, } from '@elastic/eui'; -import { - EuiBasicTable, - EuiFlexGroup, - EuiFlexItem, - EuiLoadingSpinner, - EuiSpacer, -} from '@elastic/eui'; +import { EuiBasicTable, EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React, { useMemo } from 'react'; import type { SortState } from '../shared'; -import { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from '../shared'; +import { + MetricsNodeDetailsLink, + MetricsTableEmptyIndicesContent, + MetricsTableErrorContent, + MetricsTableLoadingContent, + MetricsTableNoIndicesContent, + NodeMetricsTableData, + NumberCell, + StepwisePagination, + UptimeCell, +} from '../shared'; import type { PodNodeMetricsRow } from './use_pod_metrics_table'; export interface PodMetricsTableProps { + data: NodeMetricsTableData; + isLoading: boolean; + setCurrentPageIndex: (value: number) => void; + setSortState: (state: SortState) => void; + sortState: SortState; timerange: { from: string; to: string; }; - isLoading: boolean; - pods: PodNodeMetricsRow[]; - pageCount: number; - currentPageIndex: number; - setCurrentPageIndex: (value: number) => void; - sortState: SortState; - setSortState: (state: SortState) => void; } export const PodMetricsTable = (props: PodMetricsTableProps) => { - const { - timerange, - isLoading, - pods, - pageCount, - currentPageIndex, - setCurrentPageIndex, - sortState, - setSortState, - } = props; + const { data, isLoading, setCurrentPageIndex, setSortState, sortState, timerange } = props; const columns = useMemo(() => podNodeColumns(timerange), [timerange]); @@ -66,42 +59,54 @@ export const PodMetricsTable = (props: PodMetricsTableProps) => { setCurrentPageIndex(0); }; - if (isLoading) { + if (data.state === 'error') { return ( - - - + <> + {data.errors.map((error) => ( + + ))} + ); + } else if (isLoading && data.state !== 'data') { + return ; + } else if (data.state === 'no-indices') { + return ; + } else if (data.state === 'empty-indices') { + return ; + } else if (data.state === 'data') { + return ( + <> + } + data-test-subj="podMetricsTable" + /> + + + + + + + + ); + } else { + return null; } - - return ( - <> - - - - - - - - - ); }; function podNodeColumns( diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts index cf097c52bc629..755a8c06aa3fa 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/pod/use_pod_metrics_table.ts @@ -71,11 +71,7 @@ export function usePodMetricsTable({ timerange, filterClauseDsl }: UseNodeMetric [filterClauseDsl] ); - const { - isLoading, - nodes: pods, - pageCount, - } = useInfrastructureNodeMetrics({ + const { data, isLoading } = useInfrastructureNodeMetrics({ metricsExplorerOptions: podMetricsOptions, timerange, transform: seriesToPodNodeMetricsRow, @@ -84,14 +80,13 @@ export function usePodMetricsTable({ timerange, filterClauseDsl }: UseNodeMetric }); return { - timerange, - isLoading, - pods, - pageCount, currentPageIndex, + data, + isLoading, setCurrentPageIndex, - sortState, setSortState, + sortState, + timerange, }; } diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_dark.svg b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_dark.svg new file mode 100644 index 0000000000000..e76cfc1027270 --- /dev/null +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_dark.svg @@ -0,0 +1,416 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_light.svg b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_light.svg new file mode 100644 index 0000000000000..a2546872380a5 --- /dev/null +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/assets/no_results_light.svg @@ -0,0 +1,416 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/error_content.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/error_content.tsx new file mode 100644 index 0000000000000..457dc193d0a9b --- /dev/null +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/error_content.tsx @@ -0,0 +1,24 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { EuiCodeBlock, EuiEmptyPrompt } from '@elastic/eui'; +import React from 'react'; + +export const MetricsTableErrorContent = ({ error }: { error: Error }) => ( + + {error.stack ?? `${error}`} + + } + color="danger" + data-test-subj="metricsTableErrorContent" + iconType="alert" + title={

{error.message}

} + titleSize="s" + /> +); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/index.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/index.ts index fa4398a279e86..b0319a472930b 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/index.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/index.ts @@ -5,7 +5,13 @@ * 2.0. */ +export { MetricsTableErrorContent } from './error_content'; export { MetricsNodeDetailsLink } from './metrics_node_details_link'; +export { + MetricsTableEmptyIndicesContent, + MetricsTableLoadingContent, + MetricsTableNoIndicesContent, +} from './no_data_content'; export { NumberCell } from './number_cell'; export { StepwisePagination } from './stepwise_pagination'; export { UptimeCell } from './uptime_cell'; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/no_data_content.tsx b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/no_data_content.tsx new file mode 100644 index 0000000000000..55f403d960ff5 --- /dev/null +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/components/no_data_content.tsx @@ -0,0 +1,128 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + COLOR_MODES_STANDARD, + EuiButton, + EuiDescriptionList, + EuiDescriptionListDescription, + EuiDescriptionListTitle, + EuiEmptyPrompt, + EuiImage, + EuiLoadingLogo, + useEuiTheme, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { useLinkProps } from '@kbn/observability-plugin/public'; +import React from 'react'; +import { + noMetricIndicesPromptDescription, + noMetricIndicesPromptPrimaryActionTitle, + noMetricIndicesPromptTitle, +} from '../../../empty_states'; +import noResultsIllustrationDark from './assets/no_results_dark.svg'; +import noResultsIllustrationLight from './assets/no_results_light.svg'; + +export const MetricsTableLoadingContent = () => ( + } + title={ +

+ +

+ } + /> +); + +export const MetricsTableNoIndicesContent = () => { + const integrationsLinkProps = useLinkProps({ app: 'integrations', pathname: 'browse' }); + + return ( + {noMetricIndicesPromptTitle}} + body={

{noMetricIndicesPromptDescription}

} + actions={ + + {noMetricIndicesPromptPrimaryActionTitle} + + } + /> + ); +}; + +export const MetricsTableEmptyIndicesContent = () => { + return ( + + + + + + + + + + + + + + + } + color="subdued" + data-test-subj="metricsTableEmptyIndicesContent" + icon={} + layout="horizontal" + title={ +

+ +

+ } + titleSize="m" + /> + ); +}; + +const NoResultsIllustration = () => { + const { colorMode } = useEuiTheme(); + + const illustration = + colorMode === COLOR_MODES_STANDARD.dark + ? noResultsIllustrationDark + : noResultsIllustrationLight; + + return ( + + ); +}; + +const noResultsIllustrationAlternativeText = i18n.translate( + 'xpack.infra.metricsTable.noResultsIllustrationAlternativeText', + { defaultMessage: 'A magnifying glass with an exclamation mark' } +); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/use_infrastructure_node_metrics.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/use_infrastructure_node_metrics.ts index 93ddcc8bf4aa8..95e388d3aae64 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/use_infrastructure_node_metrics.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/hooks/use_infrastructure_node_metrics.ts @@ -19,6 +19,7 @@ import type { MetricsExplorerTimeOptions, } from '../../../../pages/metrics/metrics_explorer/hooks/use_metrics_explorer_options'; import { useTrackedPromise } from '../../../../utils/use_tracked_promise'; +import { NodeMetricsTableData } from '../types'; export interface SortState { field: keyof T; @@ -51,10 +52,10 @@ export const useInfrastructureNodeMetrics = ( const [transformedNodes, setTransformedNodes] = useState([]); const fetch = useKibanaHttpFetch(); - const { source, isLoadingSource } = useSourceContext(); + const { source, isLoadingSource, loadSourceRequest, metricIndicesExist } = useSourceContext(); const timerangeWithInterval = useTimerangeWithInterval(timerange); - const [{ state: promiseState }, fetchNodes] = useTrackedPromise( + const [fetchNodesRequest, fetchNodes] = useTrackedPromise( { createPromise: (): Promise => { if (!source) { @@ -78,16 +79,22 @@ export const useInfrastructureNodeMetrics = ( onResolve: (response: MetricsExplorerResponse) => { setTransformedNodes(response.series.map(transform)); }, - onReject: (error) => { - // What to do about this? - // eslint-disable-next-line no-console - console.log(error); - }, cancelPreviousOn: 'creation', }, [source, metricsExplorerOptions, timerangeWithInterval] ); - const isLoadingNodes = promiseState === 'pending' || promiseState === 'uninitialized'; + + const isLoadingNodes = + fetchNodesRequest.state === 'pending' || fetchNodesRequest.state === 'uninitialized'; + const isLoading = isLoadingSource || isLoadingNodes; + + const errors = useMemo( + () => [ + ...(loadSourceRequest.state === 'rejected' ? [wrapAsError(loadSourceRequest.value)] : []), + ...(fetchNodesRequest.state === 'rejected' ? [wrapAsError(fetchNodesRequest.value)] : []), + ], + [fetchNodesRequest, loadSourceRequest] + ); useEffect(() => { fetchNodes(); @@ -109,10 +116,23 @@ export const useInfrastructureNodeMetrics = ( const pageCount = useMemo(() => Math.ceil(top100Nodes.length / TABLE_PAGE_SIZE), [top100Nodes]); + const data = useMemo>( + () => + errors.length > 0 + ? { state: 'error', errors } + : metricIndicesExist == null + ? { state: 'unknown' } + : !metricIndicesExist + ? { state: 'no-indices' } + : nodes.length <= 0 + ? { state: 'empty-indices' } + : { state: 'data', currentPageIndex, pageCount, rows: nodes }, + [currentPageIndex, errors, metricIndicesExist, nodes, pageCount] + ); + return { - isLoading: isLoadingSource || isLoadingNodes, - nodes, - pageCount, + isLoading, + data, }; }; @@ -188,3 +208,5 @@ function sortDescending(nodeAValue: unknown, nodeBValue: unknown) { return 0; } + +const wrapAsError = (value: any): Error => (value instanceof Error ? value : new Error(`${value}`)); diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts index 12bc83c008e8f..b980f93cd46ef 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/index.ts @@ -5,7 +5,16 @@ * 2.0. */ -export { MetricsNodeDetailsLink, NumberCell, StepwisePagination, UptimeCell } from './components'; +export { + MetricsNodeDetailsLink, + MetricsTableEmptyIndicesContent, + MetricsTableErrorContent, + MetricsTableLoadingContent, + MetricsTableNoIndicesContent, + NumberCell, + StepwisePagination, + UptimeCell, +} from './components'; export { averageOfValues, createMetricByFieldLookup, @@ -17,6 +26,7 @@ export { export type { MetricsMap, MetricsQueryOptions, SortState } from './hooks'; export type { IntegratedNodeMetricsTableProps, + NodeMetricsTableData, SourceProviderProps, UseNodeMetricsTableOptions, } from './types'; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/types.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/types.ts index 5ab363dc7fafd..36fb29c57ecc5 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/types.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/shared/types.ts @@ -21,3 +21,24 @@ export interface SourceProviderProps { export type IntegratedNodeMetricsTableProps = UseNodeMetricsTableOptions & SourceProviderProps & CoreProvidersProps; + +export type NodeMetricsTableData = + | { + state: 'unknown'; + } + | { + state: 'no-indices'; + } + | { + state: 'empty-indices'; + } + | { + state: 'data'; + currentPageIndex: number; + pageCount: number; + rows: NodeMetricsRow[]; + } + | { + state: 'error'; + errors: Error[]; + }; diff --git a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/test_helpers.ts b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/test_helpers.ts index b4c5639b00711..a84ecd94e3182 100644 --- a/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/test_helpers.ts +++ b/x-pack/plugins/infra/public/components/infrastructure_node_metrics_tables/test_helpers.ts @@ -5,9 +5,10 @@ * 2.0. */ -import { DeepPartial } from 'utility-types'; import type { HttpFetchOptions } from '@kbn/core/public'; import { coreMock } from '@kbn/core/public/mocks'; +import { I18nProvider } from '@kbn/i18n-react'; +import { DeepPartial } from 'utility-types'; import type { MetricsExplorerResponse } from '../../../common/http_api/metrics_explorer'; import type { MetricsSourceConfigurationResponse } from '../../../common/metrics_sources'; import type { CoreProvidersProps } from '../../apps/common_providers'; @@ -28,6 +29,7 @@ export function createStartServicesAccessorMock(fetchMock: NodeMetricsTableFetch const core = coreMock.createStart(); // @ts-expect-error core.http.fetch has overloads, Jest/TypeScript only picks the first definition when mocking core.http.fetch.mockImplementation(fetchMock); + core.i18n.Context.mockImplementation(I18nProvider as () => JSX.Element); const coreProvidersPropsMock: CoreProvidersProps = { core, diff --git a/x-pack/plugins/infra/public/components/logging/log_analysis_job_status/quality_warning_notices.tsx b/x-pack/plugins/infra/public/components/logging/log_analysis_job_status/quality_warning_notices.tsx index cc218953e33f9..b86df4954c431 100644 --- a/x-pack/plugins/infra/public/components/logging/log_analysis_job_status/quality_warning_notices.tsx +++ b/x-pack/plugins/infra/public/components/logging/log_analysis_job_status/quality_warning_notices.tsx @@ -86,7 +86,7 @@ export const CategoryQualityWarnings: React.FC<{ const QualityWarningReasonDescription = euiStyled(EuiDescriptionListDescription)` display: list-item; list-style-type: disc; - margin-left: ${(props) => props.theme.eui.paddingSizes.m}; + margin-left: ${(props) => props.theme.eui.euiSizeM}; `; const categoryQualityWarningCalloutTitle = i18n.translate( diff --git a/x-pack/plugins/infra/public/components/logging/log_highlights_menu.tsx b/x-pack/plugins/infra/public/components/logging/log_highlights_menu.tsx index 2fc287d405d6a..4b559c4de6f8c 100644 --- a/x-pack/plugins/infra/public/components/logging/log_highlights_menu.tsx +++ b/x-pack/plugins/infra/public/components/logging/log_highlights_menu.tsx @@ -169,7 +169,7 @@ const ActiveHighlightsIndicator = euiStyled(EuiIcon).attrs(({ theme }) => ({ size: 'm', color: theme?.eui.euiColorAccent, }))` - padding-left: ${(props) => props.theme.eui.paddingSizes.xs}; + padding-left: ${(props) => props.theme.eui.euiSizeXS}; `; const LogHighlightsMenuContent = euiStyled.div` diff --git a/x-pack/plugins/infra/public/containers/metrics_source/source.tsx b/x-pack/plugins/infra/public/containers/metrics_source/source.tsx index 1b90106d69ed2..393cad266a123 100644 --- a/x-pack/plugins/infra/public/containers/metrics_source/source.tsx +++ b/x-pack/plugins/infra/public/containers/metrics_source/source.tsx @@ -145,6 +145,7 @@ export const useSource = ({ sourceId }: { sourceId: string }) => { isUninitialized, hasFailedLoadingSource: loadSourceRequest.state === 'rejected', loadSource, + loadSourceRequest, loadSourceFailureMessage: loadSourceRequest.state === 'rejected' ? `${loadSourceRequest.value}` : undefined, metricIndicesExist, diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/bottom_drawer.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/bottom_drawer.tsx index 9e81d1310e1f9..87c63cef36428 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/bottom_drawer.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/bottom_drawer.tsx @@ -66,7 +66,7 @@ export const BottomDrawer: React.FC<{ }; const BottomActionContainer = euiStyled.div<{ isOpen: boolean; outerWidth: number }>` - padding: ${(props) => props.theme.eui.paddingSizes.m} 0; + padding: ${(props) => props.theme.eui.euiSizeM} 0; position: fixed; bottom: 0; right: 0; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/layout.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/layout.tsx index c05f07fb5e933..1bd8ea1d4f7d9 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/layout.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/layout.tsx @@ -226,5 +226,5 @@ const MainContainer = euiStyled.div` `; const TopActionContainer = euiStyled.div` - padding: ${(props) => `12px ${props.theme.eui.paddingSizes.m}`}; + padding: ${(props) => `12px ${props.theme.eui.euiSizeM}`}; `; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/overlay.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/overlay.tsx index d4e0b351fbe44..ca52144367ea9 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/overlay.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/overlay.tsx @@ -182,9 +182,9 @@ export const NodeContextPopover = ({ }; const OverlayHeader = euiStyled.div` - padding-top: ${(props) => props.theme.eui.paddingSizes.m}; - padding-right: ${(props) => props.theme.eui.paddingSizes.m}; - padding-left: ${(props) => props.theme.eui.paddingSizes.m}; + padding-top: ${(props) => props.theme.eui.euiSizeM}; + padding-right: ${(props) => props.theme.eui.euiSizeM}; + padding-left: ${(props) => props.theme.eui.euiSizeM}; background-color: ${(props) => props.theme.eui.euiPageBackgroundColor}; box-shadow: inset 0 -1px ${(props) => props.theme.eui.euiBorderColor}; `; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/processes/process_row.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/processes/process_row.tsx index d05c49c724579..34abcc4f6b56e 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/processes/process_row.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/processes/process_row.tsx @@ -149,6 +149,6 @@ const ExpandedRowCell = euiStyled(EuiTableRowCell).attrs({ colSpan: 6, })<{ commandHeight: number }>` height: ${(props) => props.commandHeight + 240}px; - padding: 0 ${(props) => props.theme.eui.paddingSizes.m}; + padding: 0 ${(props) => props.theme.eui.euiSizeM}; background-color: ${(props) => props.theme.eui.euiColorLightestShade}; `; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/shared.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/shared.tsx index 41449e195ade8..2d65ef9c01fc6 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/shared.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/shared.tsx @@ -20,7 +20,7 @@ export interface TabProps { export const OVERLAY_Y_START = 266; export const OVERLAY_BOTTOM_MARGIN = 16; export const TabContent = euiStyled.div` - padding: ${(props) => props.theme.eui.paddingSizes.m}; + padding: ${(props) => props.theme.eui.euiSizeM}; flex: 1; overflow-y: auto; overflow-x: hidden; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/nodes_overview.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/nodes_overview.tsx index ab0a75e1cd9f5..edc112eda07df 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/nodes_overview.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/nodes_overview.tsx @@ -143,7 +143,7 @@ export const NodesOverview = ({ }; const TableContainer = euiStyled.div` - padding: ${(props) => props.theme.eui.paddingSizes.l}; + padding: ${(props) => props.theme.eui.euiSizeL}; `; const MapContainer = euiStyled.div<{ top: number; positionStatic: boolean }>` diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/timeline/timeline.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/timeline/timeline.tsx index 7ea6d8c4e5224..7e8294974e440 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/timeline/timeline.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/timeline/timeline.tsx @@ -311,8 +311,7 @@ const TimelineContainer = euiStyled.div` border-top: 1px solid ${(props) => props.theme.eui.euiColorLightShade}; height: 220px; width: 100%; - padding: ${(props) => props.theme.eui.paddingSizes.s} ${(props) => - props.theme.eui.paddingSizes.m}; + padding: ${(props) => props.theme.eui.euiSizeS} ${(props) => props.theme.eui.euiSizeM}; display: flex; flex-direction: column; `; @@ -320,15 +319,14 @@ const TimelineContainer = euiStyled.div` const TimelineHeader = euiStyled.div` display: flex; width: 100%; - padding: ${(props) => props.theme.eui.paddingSizes.s} ${(props) => - props.theme.eui.paddingSizes.m}; + padding: ${(props) => props.theme.eui.euiSizeS} ${(props) => props.theme.eui.euiSizeM}; @media only screen and (max-width: 767px) { margin-top: 30px; } `; const TimelineChartContainer = euiStyled.div` - padding-left: ${(props) => props.theme.eui.paddingSizes.xs}; + padding-left: ${(props) => props.theme.eui.euiSizeXS}; width: 100%; height: 100%; `; diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.tsx index fdc4ff0124cf6..f96d541afe9f8 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.tsx @@ -59,8 +59,8 @@ export const ConditionalToolTip = withTheme(({ theme, node, nodeType, currentTim
{node.name} diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx index c55bdba5179b6..30d25cd183fad 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx @@ -157,7 +157,7 @@ export const CustomMetricForm = withTheme(
@@ -218,11 +218,11 @@ export const CustomMetricForm = withTheme( />
-
+
return (
diff --git a/x-pack/plugins/infra/public/pages/metrics/metric_detail/components/metadata_details.tsx b/x-pack/plugins/infra/public/pages/metrics/metric_detail/components/metadata_details.tsx index 924e82fc4a4df..edd760bc17f64 100644 --- a/x-pack/plugins/infra/public/pages/metrics/metric_detail/components/metadata_details.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/metric_detail/components/metadata_details.tsx @@ -169,13 +169,13 @@ border-top: ${(props) => props.theme.eui.euiBorderWidthThin} solid ${(props) => props.theme.eui.euiBorderColor}; border-bottom: ${(props) => props.theme.eui.euiBorderWidthThin} solid ${(props) => props.theme.eui.euiBorderColor}; -padding: ${(props) => props.theme.eui.paddingSizes.m} 0; -margin-bottom: ${(props) => props.theme.eui.paddingSizes.m}; +padding: ${(props) => props.theme.eui.euiSizeM} 0; +margin-bottom: ${(props) => props.theme.eui.euiSizeM}; display: flex; `; const Controls = euiStyled.div` flex-grow: 0; -margin-right: ${(props) => props.theme.eui.paddingSizes.m}; +margin-right: ${(props) => props.theme.eui.euiSizeM}; min-width: 0px; `; diff --git a/x-pack/plugins/infra/public/pages/metrics/page_template.tsx b/x-pack/plugins/infra/public/pages/metrics/page_template.tsx index 3cac0b68ec91c..53a0cc21dd7ce 100644 --- a/x-pack/plugins/infra/public/pages/metrics/page_template.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/page_template.tsx @@ -5,10 +5,14 @@ * 2.0. */ -import React from 'react'; import { i18n } from '@kbn/i18n'; import type { LazyObservabilityPageTemplateProps } from '@kbn/observability-plugin/public'; import { KibanaPageTemplateProps } from '@kbn/shared-ux-components'; +import React from 'react'; +import { + noMetricIndicesPromptDescription, + noMetricIndicesPromptPrimaryActionTitle, +} from '../../components/empty_states'; import { useKibanaContextForPlugin } from '../../hooks/use_kibana'; interface MetricsPageTemplateProps extends LazyObservabilityPageTemplateProps { @@ -37,13 +41,8 @@ export const MetricsPageTemplate: React.FC = ({ }), action: { beats: { - title: i18n.translate('xpack.infra.metrics.noDataConfig.beatsCard.title', { - defaultMessage: 'Add a metrics integration', - }), - description: i18n.translate('xpack.infra.metrics.noDataConfig.beatsCard.description', { - defaultMessage: - 'Use Beats to send metrics data to Elasticsearch. We make it easy with modules for many popular systems and apps.', - }), + title: noMetricIndicesPromptPrimaryActionTitle, + description: noMetricIndicesPromptDescription, }, }, docsLink: docLinks.links.observability.guide, diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts index 108e4d908d801..e29510d344b40 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipelines_create.helpers.ts @@ -16,15 +16,18 @@ export type PipelinesCreateTestBed = TestBed & { actions: ReturnType; }; -const testBedConfig: AsyncTestBedConfig = { - memoryRouter: { - initialEntries: [getCreatePath()], - componentRoutePath: ROUTES.create, - }, - doMountAsync: true, -}; +export const setup = async ( + httpSetup: HttpSetup, + queryParams: string = '' +): Promise => { + const testBedConfig: AsyncTestBedConfig = { + memoryRouter: { + initialEntries: [`${getCreatePath()}${queryParams}`], + componentRoutePath: ROUTES.create, + }, + doMountAsync: true, + }; -export const setup = async (httpSetup: HttpSetup): Promise => { const initTestBed = registerTestBed( WithAppDependencies(PipelinesCreate, httpSetup), testBedConfig diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx index ebc7acee3095e..f67d9d24ed690 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx @@ -80,6 +80,18 @@ describe('', () => { expect(find('apiRequestFlyout.apiRequestFlyoutTitle').text()).toBe('Request'); }); + test('should allow to prepopulate the name field', async () => { + await act(async () => { + testBed = await setup(httpSetup, '?name=test-pipeline'); + }); + + testBed.component.update(); + + expect(testBed.exists('nameField.input')).toBe(true); + expect(testBed.find('nameField.input').props().disabled).toBe(true); + expect(testBed.find('nameField.input').props().value).toBe('test-pipeline'); + }); + describe('form validation', () => { test('should prevent form submission if required fields are missing', async () => { const { form, actions, component, find } = testBed; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx index 36e7a78c87d92..ebb177f504c70 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx @@ -27,6 +27,8 @@ export interface PipelineFormProps { saveError: any; defaultValue?: Pipeline; isEditing?: boolean; + // That fields is used to disable the name field when creating a pipeline with the name prepopulated + canEditName?: boolean; } const defaultFormValue: Pipeline = Object.freeze({ @@ -43,6 +45,7 @@ export const PipelineForm: React.FunctionComponent = ({ saveError, isEditing, onCancel, + canEditName, }) => { const [isRequestVisible, setIsRequestVisible] = useState(false); @@ -129,6 +132,7 @@ export const PipelineForm: React.FunctionComponent = ({ onProcessorsUpdate={onProcessorsChangeHandler} hasVersion={Boolean(defaultValue.version)} isEditing={isEditing} + canEditName={canEditName} /> {/* Form submission */} diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx index 7beb057cef30e..aac3fa2914467 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx @@ -28,6 +28,7 @@ interface Props { hasVersion: boolean; onEditorFlyoutOpen: () => void; isEditing?: boolean; + canEditName?: boolean; } const UseField = getUseField({ component: Field }); @@ -41,6 +42,7 @@ export const PipelineFormFields: React.FunctionComponent = ({ isEditing, hasVersion, onEditorFlyoutOpen, + canEditName, }) => { const [isVersionVisible, setIsVersionVisible] = useState(hasVersion); @@ -74,7 +76,7 @@ export const PipelineFormFields: React.FunctionComponent = ({ path="name" componentProps={{ ['data-test-subj']: 'nameField', - euiFieldProps: { disabled: Boolean(isEditing) }, + euiFieldProps: { disabled: canEditName === false || Boolean(isEditing) }, }} /> diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx new file mode 100644 index 0000000000000..58a981e34f131 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/index.tsx @@ -0,0 +1,8 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { useRedirectPath as useRedirectToPathOrRedirectPath } from './redirect_path'; diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx new file mode 100644 index 0000000000000..a387661fc1b53 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.test.tsx @@ -0,0 +1,56 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { renderHook } from '@testing-library/react-hooks'; +import { createMemoryHistory } from 'history'; +import { useRedirectPath } from './redirect_path'; +import { useKibana } from '../../shared_imports'; + +const mockedUseKibana = useKibana as jest.MockedFunction; +jest.mock('../../shared_imports'); + +describe('useRedirectPath', () => { + const mockedNavigateToUrl = jest.fn(); + beforeEach(() => { + mockedNavigateToUrl.mockReset(); + mockedUseKibana.mockReturnValue({ + services: { + application: { + navigateToUrl: mockedNavigateToUrl, + }, + }, + } as any); + }); + it('should redirect to redirect path if a redirect path is specified in the url', () => { + const history = createMemoryHistory(); + history.push( + '/app/management/ingest/ingest_pipelines/create?name=logs-system.syslog@custom&redirect_path=/test-redirect-path' + ); + + const { + result: { current: redirectToPathOrRedirectPath }, + } = renderHook(() => useRedirectPath(history)); + + redirectToPathOrRedirectPath('/test'); + + expect(mockedNavigateToUrl).toBeCalledWith('/test-redirect-path'); + }); + + it('should redirect to the provided path if no redirect path is specified in the url', () => { + const history = createMemoryHistory(); + history.push('/app/management/ingest/ingest_pipelines/create'); + + const { + result: { current: redirectToPathOrRedirectPath }, + } = renderHook(() => useRedirectPath(history)); + + redirectToPathOrRedirectPath('/test'); + + expect(mockedNavigateToUrl).not.toBeCalled(); + expect(history.location.pathname).toBe('/test'); + }); +}); diff --git a/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx new file mode 100644 index 0000000000000..e70e094081da3 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/hooks/redirect_path.tsx @@ -0,0 +1,35 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { History } from 'history'; +import { useCallback, useMemo } from 'react'; + +import { useKibana } from '../../shared_imports'; + +/** + * This hook allow to redirect to the provided path or using redirect_path if it's provided in the query params. + */ +export function useRedirectPath(history: History) { + const { services } = useKibana(); + + const redirectPath = useMemo(() => { + const locationSearchParams = new URLSearchParams(history.location.search); + + return locationSearchParams.get('redirect_path'); + }, [history.location.search]); + + return useCallback( + (path: string) => { + if (redirectPath) { + services.application.navigateToUrl(redirectPath); + } else { + history.push(path); + } + }, + [redirectPath, services.application, history] + ); +} diff --git a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx index a7fbf6afaebf8..763751b2fabc9 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_create/pipelines_create.tsx @@ -14,6 +14,7 @@ import { getListPath } from '../../services/navigation'; import { Pipeline } from '../../../../common/types'; import { useKibana } from '../../../shared_imports'; import { PipelineForm } from '../../components'; +import { useRedirectToPathOrRedirectPath } from '../../hooks'; interface Props { /** @@ -26,15 +27,48 @@ interface LocationState { sourcePipeline?: Pipeline; } +function useFormDefaultValue(sourcePipeline?: Pipeline) { + const history = useHistory(); + + const locationSearchParams = useMemo(() => { + return new URLSearchParams(history.location.search); + }, [history.location.search]); + + const formDefaultValue = useMemo(() => { + if (sourcePipeline) { + return sourcePipeline; + } + + if (history.location.state?.sourcePipeline) { + return history.location.state.sourcePipeline; + } + + if (locationSearchParams.has('name')) { + return { + name: locationSearchParams.get('name') as string, + description: '', + processors: [], + on_failure: [], + }; + } + }, [sourcePipeline, history, locationSearchParams]); + + return { formDefaultValue, canEditName: !locationSearchParams.has('name') }; +} + export const PipelinesCreate: React.FunctionComponent = ({ sourcePipeline, }) => { const history = useHistory(); + const { services } = useKibana(); const [isSaving, setIsSaving] = useState(false); const [saveError, setSaveError] = useState(null); + const { formDefaultValue, canEditName } = useFormDefaultValue(sourcePipeline); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); + const onSave = async (pipeline: Pipeline) => { setIsSaving(true); setSaveError(null); @@ -48,27 +82,15 @@ export const PipelinesCreate: React.FunctionComponent { - history.push(getListPath()); - }; + const onCancel = () => redirectToPathOrRedirectPath(getListPath()); useEffect(() => { services.breadcrumbs.setBreadcrumbs('create'); }, [services]); - const formDefaultValue = useMemo(() => { - if (sourcePipeline) { - return sourcePipeline; - } - - if (history.location.state?.sourcePipeline) { - return history.location.state.sourcePipeline; - } - }, [sourcePipeline, history]); - return ( <> (false); const [saveError, setSaveError] = useState(null); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); const decodedPipelineName = attemptToURIDecode(name)!; @@ -60,11 +62,11 @@ export const PipelinesEdit: React.FunctionComponent { - history.push(getListPath()); + redirectToPathOrRedirectPath(getListPath()); }; useEffect(() => { diff --git a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx index 4e53cabd9dcbb..5f084a7cc65f7 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx @@ -30,6 +30,7 @@ import { PipelineTable } from './table'; import { PipelineDetailsFlyout } from './details_flyout'; import { PipelineNotFoundFlyout } from './not_found_flyout'; import { PipelineDeleteModal } from './delete_modal'; +import { useRedirectToPathOrRedirectPath } from '../../hooks'; const getPipelineNameFromLocation = (location: Location) => { const { pipeline } = parse(location.search.substring(1)); @@ -49,6 +50,7 @@ export const PipelinesList: React.FunctionComponent = ({ const [pipelinesToDelete, setPipelinesToDelete] = useState([]); const { data, isLoading, error, resendRequest } = services.api.useLoadPipelines(); + const redirectToPathOrRedirectPath = useRedirectToPathOrRedirectPath(history); // Track component loaded useEffect(() => { @@ -74,7 +76,7 @@ export const PipelinesList: React.FunctionComponent = ({ const goHome = () => { setShowFlyout(false); - history.push(getListPath()); + redirectToPathOrRedirectPath(getListPath()); }; if (error) { diff --git a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx index 08b6354abf201..38e2bb89da854 100644 --- a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx +++ b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.test.tsx @@ -55,6 +55,7 @@ const renderWithRouter = ( startDate: '2022-03-08T18:52:15.532Z', endDate: '2022-06-09T17:52:15.532Z', }} + renderSessionsView={jest.fn()} /> ); diff --git a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx index f2949dd0e4ab1..7fe4b2ea3976a 100644 --- a/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx +++ b/x-pack/plugins/kubernetes_security/public/components/kubernetes_security_routes/index.tsx @@ -12,7 +12,6 @@ import { EuiFlexGroup, EuiFlexItem, EuiIconTip, - EuiLoadingContent, EuiSpacer, EuiText, EuiTextColor, @@ -31,11 +30,13 @@ import { PercentWidget } from '../percent_widget'; import { KubernetesSecurityDeps } from '../../types'; import { AggregateResult } from '../../../common/types/aggregate'; import { useStyles } from './styles'; +import { TreeViewContainer } from '../tree_view_container'; const KubernetesSecurityRoutesComponent = ({ filter, indexPattern, globalFilter, + renderSessionsView, }: KubernetesSecurityDeps) => { const styles = useStyles(); @@ -203,10 +204,7 @@ const KubernetesSecurityRoutesComponent = ({ /> -
- - -
+ ); diff --git a/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts b/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts index 5e90d7c946f92..57f1427710999 100644 --- a/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts +++ b/x-pack/plugins/kubernetes_security/public/components/percent_widget/styles.ts @@ -17,8 +17,8 @@ export const useStyles = () => { const container: CSSObject = { padding: size.base, - border: euiTheme.border.thin, - borderRadius: euiTheme.border.radius.medium, + border: border.thin, + borderRadius: border.radius.medium, overflow: 'auto', position: 'relative', }; diff --git a/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx new file mode 100644 index 0000000000000..e934fe4a31f2d --- /dev/null +++ b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/index.tsx @@ -0,0 +1,35 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiSplitPanel, EuiText } from '@elastic/eui'; +import { useStyles } from './styles'; +import type { IndexPattern, GlobalFilter } from '../../types'; + +export interface TreeViewContainerDeps { + globalFilter: GlobalFilter; + renderSessionsView: (sessionsFilterQuery: string | undefined) => JSX.Element; + indexPattern?: IndexPattern; +} + +export const TreeViewContainer = ({ globalFilter, renderSessionsView }: TreeViewContainerDeps) => { + const styles = useStyles(); + // TODO: combine filterQuery with filters from tree view nav + + return ( + + + +

Tree view nav panel

+ + + + {renderSessionsView(globalFilter.filterQuery)} + + + ); +}; diff --git a/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts new file mode 100644 index 0000000000000..c490e5b711889 --- /dev/null +++ b/x-pack/plugins/kubernetes_security/public/components/tree_view_container/styles.ts @@ -0,0 +1,43 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useMemo } from 'react'; +import { CSSObject } from '@emotion/react'; +import { useEuiTheme } from '../../hooks'; + +export const useStyles = () => { + const { euiTheme } = useEuiTheme(); + + const cached = useMemo(() => { + const { border } = euiTheme; + + const outerPanel: CSSObject = { + minHeight: '500px', + }; + + const navPanel: CSSObject = { + borderRight: border.thin, + }; + + const treeViewNav: CSSObject = { + width: '284px', + }; + + const sessionsPanel: CSSObject = { + overflowX: 'auto', + }; + + return { + outerPanel, + navPanel, + treeViewNav, + sessionsPanel, + }; + }, [euiTheme]); + + return cached; +}; diff --git a/x-pack/plugins/kubernetes_security/public/types.ts b/x-pack/plugins/kubernetes_security/public/types.ts index d6313b25bf011..bf25e00eec2b2 100644 --- a/x-pack/plugins/kubernetes_security/public/types.ts +++ b/x-pack/plugins/kubernetes_security/public/types.ts @@ -32,6 +32,7 @@ export interface GlobalFilter { export interface KubernetesSecurityDeps { filter: React.ReactNode; + renderSessionsView: (sessionsFilterQuery: string | undefined) => JSX.Element; indexPattern?: IndexPattern; globalFilter: GlobalFilter; } diff --git a/x-pack/plugins/lens/common/expressions/index.ts b/x-pack/plugins/lens/common/expressions/index.ts index 924141da6074a..ccb6343334d62 100644 --- a/x-pack/plugins/lens/common/expressions/index.ts +++ b/x-pack/plugins/lens/common/expressions/index.ts @@ -8,6 +8,6 @@ export * from './counter_rate'; export * from './collapse'; export * from './format_column'; -export * from './rename_columns'; +export * from './map_to_columns'; export * from './time_scale'; export * from './datatable'; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts new file mode 100644 index 0000000000000..8ce71d06f6579 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/index.ts @@ -0,0 +1,8 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { mapToColumns } from './map_to_columns'; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts new file mode 100644 index 0000000000000..e5d678b88e5a5 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.test.ts @@ -0,0 +1,282 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mapToColumns } from './map_to_columns'; +import { Datatable } from '@kbn/expressions-plugin/common'; +import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; + +describe('map_to_columns', () => { + it('should rename columns of a given datatable', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'B', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + a: [ + { + id: 'b', + label: 'Austrailia', + }, + ], + b: [ + { + id: 'c', + label: 'Boomerang', + }, + ], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "b", + "meta": Object { + "type": "number", + }, + "name": "Austrailia", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Boomerang", + }, + ], + "rows": Array [ + Object { + "b": 1, + "c": 2, + }, + Object { + "b": 3, + "c": 4, + }, + Object { + "b": 5, + "c": 6, + }, + Object { + "b": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should keep columns which are not mapped', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'B', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + b: [{ id: 'c', label: 'Catamaran' }], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "a", + "meta": Object { + "type": "number", + }, + "name": "A", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Catamaran", + }, + ], + "rows": Array [ + Object { + "a": 1, + "c": 2, + }, + Object { + "a": 3, + "c": 4, + }, + Object { + "a": 5, + "c": 6, + }, + Object { + "a": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should map to multiple original columns', async () => { + const input: Datatable = { + type: 'datatable', + columns: [{ id: 'b', name: 'B', meta: { type: 'number' } }], + rows: [{ b: 2 }, { b: 4 }, { b: 6 }, { b: 8 }], + }; + + const idMap = { + b: [ + { id: 'c', label: 'Catamaran' }, + { id: 'd', label: 'Dinghy' }, + ], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Catamaran", + }, + Object { + "id": "d", + "meta": Object { + "type": "number", + }, + "name": "Dinghy", + }, + ], + "rows": Array [ + Object { + "c": 2, + "d": 2, + }, + Object { + "c": 4, + "d": 4, + }, + Object { + "c": 6, + "d": 6, + }, + Object { + "c": 8, + "d": 8, + }, + ], + "type": "datatable", + } + `); + }); + + it('should rename date histograms', async () => { + const input: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'A', meta: { type: 'number' } }, + { id: 'b', name: 'banana per 30 seconds', meta: { type: 'number' } }, + ], + rows: [ + { a: 1, b: 2 }, + { a: 3, b: 4 }, + { a: 5, b: 6 }, + { a: 7, b: 8 }, + ], + }; + + const idMap = { + b: [{ id: 'c', label: 'Apple', operationType: 'date_histogram', sourceField: 'banana' }], + }; + + const result = await mapToColumns.fn( + input, + { idMap: JSON.stringify(idMap) }, + createMockExecutionContext() + ); + + expect(result).toMatchInlineSnapshot(` + Object { + "columns": Array [ + Object { + "id": "a", + "meta": Object { + "type": "number", + }, + "name": "A", + }, + Object { + "id": "c", + "meta": Object { + "type": "number", + }, + "name": "Apple per 30 seconds", + }, + ], + "rows": Array [ + Object { + "a": 1, + "c": 2, + }, + Object { + "a": 3, + "c": 4, + }, + Object { + "a": 5, + "c": 6, + }, + Object { + "a": 7, + "c": 8, + }, + ], + "type": "datatable", + } + `); + }); +}); diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts new file mode 100644 index 0000000000000..3315cd4170dd9 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns.ts @@ -0,0 +1,32 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import type { MapToColumnsExpressionFunction } from './types'; + +export const mapToColumns: MapToColumnsExpressionFunction = { + name: 'lens_map_to_columns', + type: 'datatable', + help: i18n.translate('xpack.lens.functions.mapToColumns.help', { + defaultMessage: 'A helper to transform a datatable to match Lens column definitions', + }), + args: { + idMap: { + types: ['string'], + help: i18n.translate('xpack.lens.functions.mapToColumns.idMap.help', { + defaultMessage: + 'A JSON encoded object in which keys are the datatable column ids and values are the Lens column definitions. Any datatable columns not mentioned within the ID map will be kept unmapped.', + }), + }, + }, + inputTypes: ['datatable'], + async fn(...args) { + /** Build optimization: prevent adding extra code into initial bundle **/ + const { mapToOriginalColumns } = await import('./map_to_columns_fn'); + return mapToOriginalColumns(...args); + }, +}; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts new file mode 100644 index 0000000000000..401051db71065 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/map_to_columns_fn.ts @@ -0,0 +1,63 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { DatatableColumn } from '@kbn/expressions-plugin/common'; +import type { OriginalColumn, MapToColumnsExpressionFunction } from './types'; + +function getColumnName(originalColumn: OriginalColumn, newColumn: DatatableColumn) { + if (originalColumn?.operationType === 'date_histogram') { + const fieldName = originalColumn.sourceField; + + // HACK: This is a hack, and introduces some fragility into + // column naming. Eventually, this should be calculated and + // built more systematically. + return newColumn.name.replace(fieldName, originalColumn.label); + } + + return originalColumn.label; +} + +export const mapToOriginalColumns: MapToColumnsExpressionFunction['fn'] = ( + data, + { idMap: encodedIdMap } +) => { + const idMap = JSON.parse(encodedIdMap) as Record; + + return { + ...data, + rows: data.rows.map((row) => { + const mappedRow: Record = {}; + + Object.entries(row).forEach(([id, value]) => { + if (id in idMap) { + idMap[id].forEach(({ id: originalId }) => { + mappedRow[originalId] = value; + }); + } else { + mappedRow[id] = value; + } + }); + + return mappedRow; + }), + columns: data.columns + .map((column) => { + const originalColumns = idMap[column.id]; + + if (!originalColumns) { + return column; + } + + return originalColumns.map((originalColumn) => ({ + ...column, + id: originalColumn.id, + name: getColumnName(originalColumn, column), + })); + }) + .flat(), + }; +}; diff --git a/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts b/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts new file mode 100644 index 0000000000000..0c99260b704b1 --- /dev/null +++ b/x-pack/plugins/lens/common/expressions/map_to_columns/types.ts @@ -0,0 +1,22 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; + +export type OriginalColumn = { id: string; label: string } & ( + | { operationType: 'date_histogram'; sourceField: string } + | { operationType: string; sourceField: never } +); + +export type MapToColumnsExpressionFunction = ExpressionFunctionDefinition< + 'lens_map_to_columns', + Datatable, + { + idMap: string; + }, + Datatable | Promise +>; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/index.ts b/x-pack/plugins/lens/common/expressions/rename_columns/index.ts deleted file mode 100644 index 86ab16e06ec01..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/index.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -export { renameColumns } from './rename_columns'; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts deleted file mode 100644 index 2047e4647cb4c..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.test.ts +++ /dev/null @@ -1,217 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { renameColumns } from './rename_columns'; -import { Datatable } from '@kbn/expressions-plugin/common'; -import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; - -describe('rename_columns', () => { - it('should rename columns of a given datatable', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'B', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - a: { - id: 'b', - label: 'Austrailia', - }, - b: { - id: 'c', - label: 'Boomerang', - }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "b", - "meta": Object { - "type": "number", - }, - "name": "Austrailia", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Boomerang", - }, - ], - "rows": Array [ - Object { - "b": 1, - "c": 2, - }, - Object { - "b": 3, - "c": 4, - }, - Object { - "b": 5, - "c": 6, - }, - Object { - "b": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); - - it('should keep columns which are not mapped', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'B', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - b: { id: 'c', label: 'Catamaran' }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "a", - "meta": Object { - "type": "number", - }, - "name": "A", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Catamaran", - }, - ], - "rows": Array [ - Object { - "a": 1, - "c": 2, - }, - Object { - "a": 3, - "c": 4, - }, - Object { - "a": 5, - "c": 6, - }, - Object { - "a": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); - - it('should rename date histograms', async () => { - const input: Datatable = { - type: 'datatable', - columns: [ - { id: 'a', name: 'A', meta: { type: 'number' } }, - { id: 'b', name: 'banana per 30 seconds', meta: { type: 'number' } }, - ], - rows: [ - { a: 1, b: 2 }, - { a: 3, b: 4 }, - { a: 5, b: 6 }, - { a: 7, b: 8 }, - ], - }; - - const idMap = { - b: { id: 'c', label: 'Apple', operationType: 'date_histogram', sourceField: 'banana' }, - }; - - const result = await renameColumns.fn( - input, - { idMap: JSON.stringify(idMap) }, - createMockExecutionContext() - ); - - expect(result).toMatchInlineSnapshot(` - Object { - "columns": Array [ - Object { - "id": "a", - "meta": Object { - "type": "number", - }, - "name": "A", - }, - Object { - "id": "c", - "meta": Object { - "type": "number", - }, - "name": "Apple per 30 seconds", - }, - ], - "rows": Array [ - Object { - "a": 1, - "c": 2, - }, - Object { - "a": 3, - "c": 4, - }, - Object { - "a": 5, - "c": 6, - }, - Object { - "a": 7, - "c": 8, - }, - ], - "type": "datatable", - } - `); - }); -}); diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts deleted file mode 100644 index d425d5c80d18d..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns.ts +++ /dev/null @@ -1,32 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { i18n } from '@kbn/i18n'; -import type { RenameColumnsExpressionFunction } from './types'; - -export const renameColumns: RenameColumnsExpressionFunction = { - name: 'lens_rename_columns', - type: 'datatable', - help: i18n.translate('xpack.lens.functions.renameColumns.help', { - defaultMessage: 'A helper to rename the columns of a datatable', - }), - args: { - idMap: { - types: ['string'], - help: i18n.translate('xpack.lens.functions.renameColumns.idMap.help', { - defaultMessage: - 'A JSON encoded object in which keys are the old column ids and values are the corresponding new ones. All other columns ids are kept.', - }), - }, - }, - inputTypes: ['datatable'], - async fn(...args) { - /** Build optimization: prevent adding extra code into initial bundle **/ - const { renameColumnFn } = await import('./rename_columns_fn'); - return renameColumnFn(...args); - }, -}; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts b/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts deleted file mode 100644 index 3cf4293ffa9f2..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/rename_columns_fn.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { DatatableColumn } from '@kbn/expressions-plugin/common'; -import type { OriginalColumn, RenameColumnsExpressionFunction } from './types'; - -function getColumnName(originalColumn: OriginalColumn, newColumn: DatatableColumn) { - if (originalColumn?.operationType === 'date_histogram') { - const fieldName = originalColumn.sourceField; - - // HACK: This is a hack, and introduces some fragility into - // column naming. Eventually, this should be calculated and - // built more systematically. - return newColumn.name.replace(fieldName, originalColumn.label); - } - - return originalColumn.label; -} - -export const renameColumnFn: RenameColumnsExpressionFunction['fn'] = ( - data, - { idMap: encodedIdMap } -) => { - const idMap = JSON.parse(encodedIdMap) as Record; - - return { - ...data, - rows: data.rows.map((row) => { - const mappedRow: Record = {}; - Object.entries(idMap).forEach(([fromId, toId]) => { - mappedRow[toId.id] = row[fromId]; - }); - - Object.entries(row).forEach(([id, value]) => { - if (id in idMap) { - mappedRow[idMap[id].id] = value; - } else { - mappedRow[id] = value; - } - }); - - return mappedRow; - }), - columns: data.columns.map((column) => { - const mappedItem = idMap[column.id]; - - if (!mappedItem) { - return column; - } - - return { - ...column, - id: mappedItem.id, - name: getColumnName(mappedItem, column), - }; - }), - }; -}; diff --git a/x-pack/plugins/lens/common/expressions/rename_columns/types.ts b/x-pack/plugins/lens/common/expressions/rename_columns/types.ts deleted file mode 100644 index 6edfda41cc62f..0000000000000 --- a/x-pack/plugins/lens/common/expressions/rename_columns/types.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; - -export type OriginalColumn = { id: string; label: string } & ( - | { operationType: 'date_histogram'; sourceField: string } - | { operationType: string; sourceField: never } -); - -export type RenameColumnsExpressionFunction = ExpressionFunctionDefinition< - 'lens_rename_columns', - Datatable, - { - idMap: string; - }, - Datatable | Promise ->; diff --git a/x-pack/plugins/lens/public/drag_drop/drag_drop.test.tsx b/x-pack/plugins/lens/public/drag_drop/drag_drop.test.tsx index 1d6c14c09136a..c0d7766fc22d8 100644 --- a/x-pack/plugins/lens/public/drag_drop/drag_drop.test.tsx +++ b/x-pack/plugins/lens/public/drag_drop/drag_drop.test.tsx @@ -41,7 +41,14 @@ describe('DragDrop', () => { const value = { id: '1', - humanData: { label: 'hello', groupLabel: 'X', position: 1, canSwap: true, canDuplicate: true }, + humanData: { + label: 'hello', + groupLabel: 'X', + position: 1, + canSwap: true, + canDuplicate: true, + layerNumber: 0, + }, }; test('renders if nothing is being dragged', () => { @@ -205,7 +212,7 @@ describe('DragDrop', () => { order={[2, 0, 1, 0]} onDrop={(x: unknown) => {}} dropTypes={undefined} - value={{ id: '2', humanData: { label: 'label2' } }} + value={{ id: '2', humanData: { label: 'label2', layerNumber: 0 } }} > @@ -231,7 +238,7 @@ describe('DragDrop', () => { }} > @@ -286,7 +293,7 @@ describe('DragDrop', () => { registerDropTarget={jest.fn()} > @@ -329,7 +336,7 @@ describe('DragDrop', () => { draggable: true, value: { id: '1', - humanData: { label: 'Label1', position: 1 }, + humanData: { label: 'Label1', position: 1, layerNumber: 0 }, }, children: '1', order: [2, 0, 0, 0], @@ -341,7 +348,7 @@ describe('DragDrop', () => { value: { id: '2', - humanData: { label: 'label2', position: 1 }, + humanData: { label: 'label2', position: 1, layerNumber: 0 }, }, onDrop, dropTypes: ['move_compatible'] as DropType[], @@ -358,6 +365,7 @@ describe('DragDrop', () => { groupLabel: 'Y', canSwap: true, canDuplicate: true, + layerNumber: 0, }, }, onDrop, @@ -373,7 +381,7 @@ describe('DragDrop', () => { dragType: 'move' as 'copy' | 'move', value: { id: '4', - humanData: { label: 'label4', position: 2, groupLabel: 'Y' }, + humanData: { label: 'label4', position: 2, groupLabel: 'Y', layerNumber: 0 }, }, order: [2, 0, 2, 1], }, @@ -415,11 +423,11 @@ describe('DragDrop', () => { }); keyboardHandler.simulate('keydown', { key: 'Enter' }); expect(setA11yMessage).toBeCalledWith( - `You're dragging Label1 from at position 1 over label3 from Y group at position 1. Press space or enter to replace label3 with Label1. Hold alt or option to duplicate. Hold shift to swap.` + `You're dragging Label1 from at position 1 in layer 0 over label3 from Y group at position 1 in layer 0. Press space or enter to replace label3 with Label1. Hold alt or option to duplicate. Hold shift to swap.` ); expect(setActiveDropTarget).toBeCalledWith(undefined); expect(onDrop).toBeCalledWith( - { humanData: { label: 'Label1', position: 1 }, id: '1' }, + { humanData: { label: 'Label1', position: 1, layerNumber: 0 }, id: '1' }, 'move_compatible' ); }); @@ -474,7 +482,7 @@ describe('DragDrop', () => { draggable: true, value: { id: '1', - humanData: { label: 'Label1', position: 1 }, + humanData: { label: 'Label1', position: 1, layerNumber: 0 }, }, children: '1', order: [2, 0, 0, 0], @@ -486,7 +494,7 @@ describe('DragDrop', () => { value: { id: '2', - humanData: { label: 'label2', position: 1 }, + humanData: { label: 'label2', position: 1, layerNumber: 0 }, }, onDrop, dropTypes: ['move_compatible'] as DropType[], @@ -533,7 +541,7 @@ describe('DragDrop', () => { component = mount( { registerDropTarget={jest.fn()} > @@ -629,18 +637,24 @@ describe('DragDrop', () => { component.find('SingleDropInner').at(0).simulate('dragover'); component.find('SingleDropInner').at(0).simulate('drop'); - expect(onDrop).toBeCalledWith({ humanData: { label: 'Label1' }, id: '1' }, 'move_compatible'); + expect(onDrop).toBeCalledWith( + { humanData: { label: 'Label1', layerNumber: 0 }, id: '1' }, + 'move_compatible' + ); component.find('SingleDropInner').at(1).simulate('dragover'); component.find('SingleDropInner').at(1).simulate('drop'); expect(onDrop).toBeCalledWith( - { humanData: { label: 'Label1' }, id: '1' }, + { humanData: { label: 'Label1', layerNumber: 0 }, id: '1' }, 'duplicate_compatible' ); component.find('SingleDropInner').at(2).simulate('dragover'); component.find('SingleDropInner').at(2).simulate('drop'); - expect(onDrop).toBeCalledWith({ humanData: { label: 'Label1' }, id: '1' }, 'swap_compatible'); + expect(onDrop).toBeCalledWith( + { humanData: { label: 'Label1', layerNumber: 0 }, id: '1' }, + 'swap_compatible' + ); }); test('pressing Alt or Shift when dragging over the main drop target sets extra drop target as active', () => { @@ -693,7 +707,7 @@ describe('DragDrop', () => { draggable: true, value: { id: '1', - humanData: { label: 'Label1', position: 1 }, + humanData: { label: 'Label1', position: 1, layerNumber: 0 }, }, children: '1', order: [2, 0, 0, 0], @@ -705,7 +719,7 @@ describe('DragDrop', () => { value: { id: '2', - humanData: { label: 'label2', position: 1 }, + humanData: { label: 'label2', position: 1, layerNumber: 0 }, }, onDrop, dropTypes: ['move_compatible', 'duplicate_compatible', 'swap_compatible'] as DropType[], @@ -716,7 +730,7 @@ describe('DragDrop', () => { dragType: 'move' as const, value: { id: '3', - humanData: { label: 'label3', position: 1, groupLabel: 'Y' }, + humanData: { label: 'label3', position: 1, groupLabel: 'Y', layerNumber: 0 }, }, onDrop, dropTypes: ['replace_compatible'] as DropType[], @@ -734,6 +748,7 @@ describe('DragDrop', () => { humanData: { label: 'label2', position: 1, + layerNumber: 0, }, id: '2', onDrop, @@ -743,6 +758,7 @@ describe('DragDrop', () => { humanData: { label: 'label2', position: 1, + layerNumber: 0, }, id: '2', onDrop, @@ -753,6 +769,7 @@ describe('DragDrop', () => { groupLabel: 'Y', label: 'label3', position: 1, + layerNumber: 0, }, id: '3', onDrop, @@ -942,18 +959,18 @@ describe('DragDrop', () => { const items = [ { id: '1', - humanData: { label: 'Label1', position: 1, groupLabel: 'X' }, + humanData: { label: 'Label1', position: 1, groupLabel: 'X', layerNumber: 0 }, onDrop, draggable: true, }, { id: '2', - humanData: { label: 'label2', position: 2, groupLabel: 'X' }, + humanData: { label: 'label2', position: 2, groupLabel: 'X', layerNumber: 0 }, onDrop, }, { id: '3', - humanData: { label: 'label3', position: 3, groupLabel: 'X' }, + humanData: { label: 'label3', position: 3, groupLabel: 'X', layerNumber: 0 }, onDrop, }, ]; diff --git a/x-pack/plugins/lens/public/drag_drop/providers/announcements.tsx b/x-pack/plugins/lens/public/drag_drop/providers/announcements.tsx index 0d247825b6a17..a21656421a96f 100644 --- a/x-pack/plugins/lens/public/drag_drop/providers/announcements.tsx +++ b/x-pack/plugins/lens/public/drag_drop/providers/announcements.tsx @@ -22,19 +22,21 @@ interface CustomAnnouncementsType { const replaceAnnouncement = { selectedTarget: ( - { label, groupLabel, position }: HumanData, + { label, groupLabel, position, layerNumber }: HumanData, { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, canSwap, canDuplicate, + canCombine, + layerNumber: dropLayerNumber, }: HumanData, announceModifierKeys?: boolean ) => { if (announceModifierKeys && (canSwap || canDuplicate)) { return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.replaceMain', { - defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over {dropLabel} from {dropGroupLabel} group at position {dropPosition}. Press space or enter to replace {dropLabel} with {label}.{duplicateCopy}{swapCopy}`, + defaultMessage: `You're dragging {label} from {groupLabel} at position {position} in layer {layerNumber} over {dropLabel} from {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to replace {dropLabel} with {label}.{duplicateCopy}{swapCopy}{combineCopy}`, values: { label, groupLabel, @@ -44,63 +46,76 @@ const replaceAnnouncement = { dropPosition, duplicateCopy: canDuplicate ? DUPLICATE_SHORT : '', swapCopy: canSwap ? SWAP_SHORT : '', + combineCopy: canCombine ? COMBINE_SHORT : '', + layerNumber, + dropLayerNumber, }, }); } - return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.replace', { - defaultMessage: `Replace {dropLabel} in {dropGroupLabel} group at position {dropPosition} with {label}. Press space or enter to replace.`, + defaultMessage: `Replace {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber} with {label}. Press space or enter to replace.`, values: { label, dropLabel, dropGroupLabel, dropPosition, + dropLayerNumber, }, }); }, - dropped: ({ label }: HumanData, { label: dropLabel, groupLabel, position }: HumanData) => - i18n.translate('xpack.lens.dragDrop.announce.duplicated.replace', { - defaultMessage: 'Replaced {dropLabel} with {label} in {groupLabel} at position {position}', + dropped: ( + { label }: HumanData, + { label: dropLabel, groupLabel, position, layerNumber: dropLayerNumber }: HumanData + ) => { + return i18n.translate('xpack.lens.dragDrop.announce.duplicated.replace', { + defaultMessage: + 'Replaced {dropLabel} with {label} in {groupLabel} at position {position} in layer {dropLayerNumber}', values: { label, dropLabel, groupLabel, position, + dropLayerNumber, }, - }), + }); + }, }; const duplicateAnnouncement = { selectedTarget: ( - { label, groupLabel }: HumanData, + { label, groupLabel, layerNumber }: HumanData, { groupLabel: dropGroupLabel, position }: HumanData ) => { if (groupLabel !== dropGroupLabel) { return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.duplicated', { - defaultMessage: `Duplicate {label} to {dropGroupLabel} group at position {position}. Hold Alt or Option and press space or enter to duplicate`, + defaultMessage: `Duplicate {label} to {dropGroupLabel} group at position {position} in layer {layerNumber}. Hold Alt or Option and press space or enter to duplicate`, values: { label, dropGroupLabel, position, + layerNumber, }, }); } return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.duplicatedInGroup', { - defaultMessage: `Duplicate {label} to {dropGroupLabel} group at position {position}. Press space or enter to duplicate`, + defaultMessage: `Duplicate {label} to {dropGroupLabel} group at position {position} in layer {layerNumber}. Press space or enter to duplicate`, values: { label, dropGroupLabel, position, + layerNumber, }, }); }, - dropped: ({ label }: HumanData, { groupLabel, position }: HumanData) => + dropped: ({ label }: HumanData, { groupLabel, position, layerNumber }: HumanData) => i18n.translate('xpack.lens.dragDrop.announce.dropped.duplicated', { - defaultMessage: 'Duplicated {label} in {groupLabel} group at position {position}', + defaultMessage: + 'Duplicated {label} in {groupLabel} group at position {position} in layer {layerNumber}', values: { label, groupLabel, position, + layerNumber, }, }), }; @@ -109,8 +124,8 @@ const reorderAnnouncement = { selectedTarget: ( { label, groupLabel, position: prevPosition }: HumanData, { position }: HumanData - ) => - prevPosition === position + ) => { + return prevPosition === position ? i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.reorderedBack', { defaultMessage: `{label} returned to its initial position {prevPosition}`, values: { @@ -121,12 +136,13 @@ const reorderAnnouncement = { : i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.reordered', { defaultMessage: `Reorder {label} in {groupLabel} group from position {prevPosition} to position {position}. Press space or enter to reorder`, values: { - groupLabel, label, + groupLabel, position, prevPosition, }, - }), + }); + }, dropped: ({ label, groupLabel, position: prevPosition }: HumanData, { position }: HumanData) => i18n.translate('xpack.lens.dragDrop.announce.dropped.reordered', { defaultMessage: @@ -142,7 +158,7 @@ const reorderAnnouncement = { const combineAnnouncement = { selectedTarget: ( - { label, groupLabel, position }: HumanData, + { label, groupLabel, position, layerNumber }: HumanData, { label: dropLabel, groupLabel: dropGroupLabel, @@ -150,12 +166,13 @@ const combineAnnouncement = { canSwap, canDuplicate, canCombine, + layerNumber: dropLayerNumber, }: HumanData, announceModifierKeys?: boolean ) => { if (announceModifierKeys && (canSwap || canDuplicate || canCombine)) { return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.combineMain', { - defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over {dropLabel} from {dropGroupLabel} group at position {dropPosition}. Press space or enter to combine {dropLabel} with {label}.{duplicateCopy}{swapCopy}{combineCopy}`, + defaultMessage: `You're dragging {label} from {groupLabel} at position {position} in layer {layerNumber} over {dropLabel} from {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to combine {dropLabel} with {label}.{duplicateCopy}{swapCopy}{combineCopy}`, values: { label, groupLabel, @@ -166,28 +183,35 @@ const combineAnnouncement = { duplicateCopy: canDuplicate ? DUPLICATE_SHORT : '', swapCopy: canSwap ? SWAP_SHORT : '', combineCopy: canCombine ? COMBINE_SHORT : '', + layerNumber, + dropLayerNumber, }, }); } - return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.combine', { - defaultMessage: `Combine {dropLabel} in {dropGroupLabel} group at position {dropPosition} with {label}. Press space or enter to combine.`, + defaultMessage: `Combine {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber} with {label}. Press space or enter to combine.`, values: { label, dropLabel, dropGroupLabel, dropPosition, + dropLayerNumber, }, }); }, - dropped: ({ label }: HumanData, { label: dropLabel, groupLabel, position }: HumanData) => + dropped: ( + { label }: HumanData, + { label: dropLabel, groupLabel, position, layerNumber: dropLayerNumber }: HumanData + ) => i18n.translate('xpack.lens.dragDrop.announce.duplicated.combine', { - defaultMessage: 'Combine {dropLabel} with {label} in {groupLabel} at position {position}', + defaultMessage: + 'Combine {dropLabel} with {label} in {groupLabel} at position {position} in layer {dropLayerNumber}', values: { label, dropLabel, groupLabel, position, + dropLayerNumber, }, }), }; @@ -212,7 +236,7 @@ export const announcements: CustomAnnouncementsType = { field_combine: combineAnnouncement.selectedTarget, replace_compatible: replaceAnnouncement.selectedTarget, replace_incompatible: ( - { label, groupLabel, position }: HumanData, + { label, groupLabel, position, layerNumber }: HumanData, { label: dropLabel, groupLabel: dropGroupLabel, @@ -220,14 +244,16 @@ export const announcements: CustomAnnouncementsType = { nextLabel, canSwap, canDuplicate, + canCombine, + layerNumber: dropLayerNumber, }: HumanData, announceModifierKeys?: boolean ) => { - if (announceModifierKeys && (canSwap || canDuplicate)) { + if (announceModifierKeys && (canSwap || canDuplicate || canCombine)) { return i18n.translate( 'xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatibleMain', { - defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over {dropLabel} from {dropGroupLabel} group at position {dropPosition}. Press space or enter to convert {label} to {nextLabel} and replace {dropLabel}.{duplicateCopy}{swapCopy}`, + defaultMessage: `You're dragging {label} from {groupLabel} at position {position} in layer {layerNumber} over {dropLabel} from {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to convert {label} to {nextLabel} and replace {dropLabel}.{duplicateCopy}{swapCopy}{combineCopy}`, values: { label, groupLabel, @@ -238,35 +264,40 @@ export const announcements: CustomAnnouncementsType = { nextLabel, duplicateCopy: canDuplicate ? DUPLICATE_SHORT : '', swapCopy: canSwap ? SWAP_SHORT : '', + combineCopy: canCombine ? COMBINE_SHORT : '', + layerNumber, + dropLayerNumber, }, } ); } return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatible', { - defaultMessage: `Convert {label} to {nextLabel} and replace {dropLabel} in {dropGroupLabel} group at position {dropPosition}. Press space or enter to replace`, + defaultMessage: `Convert {label} to {nextLabel} and replace {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to replace`, values: { label, - nextLabel, dropLabel, dropGroupLabel, dropPosition, + nextLabel, + dropLayerNumber, }, }); }, move_incompatible: ( - { label, groupLabel, position }: HumanData, + { label, groupLabel, position, layerNumber }: HumanData, { groupLabel: dropGroupLabel, position: dropPosition, nextLabel, canSwap, canDuplicate, + layerNumber: dropLayerNumber, }: HumanData, announceModifierKeys?: boolean ) => { if (announceModifierKeys && (canSwap || canDuplicate)) { return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.moveIncompatibleMain', { - defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over position {dropPosition} in {dropGroupLabel} group. Press space or enter to convert {label} to {nextLabel} and move.{duplicateCopy}{swapCopy}`, + defaultMessage: `You're dragging {label} from {groupLabel} at position {position} in layer {layerNumber} over position {dropPosition} in {dropGroupLabel} group in layer {dropLayerNumber}. Press space or enter to convert {label} to {nextLabel} and move.{duplicateCopy}`, values: { label, groupLabel, @@ -275,29 +306,37 @@ export const announcements: CustomAnnouncementsType = { dropPosition, nextLabel, duplicateCopy: canDuplicate ? DUPLICATE_SHORT : '', - swapCopy: canSwap ? SWAP_SHORT : '', + layerNumber, + dropLayerNumber, }, }); } return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.moveIncompatible', { - defaultMessage: `Convert {label} to {nextLabel} and move to {dropGroupLabel} group at position {dropPosition}. Press space or enter to move`, + defaultMessage: `Convert {label} to {nextLabel} and move to {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to move`, values: { label, - nextLabel, dropGroupLabel, dropPosition, + nextLabel, + dropLayerNumber, }, }); }, move_compatible: ( { label, groupLabel, position }: HumanData, - { groupLabel: dropGroupLabel, position: dropPosition, canSwap, canDuplicate }: HumanData, + { + groupLabel: dropGroupLabel, + position: dropPosition, + canSwap, + canDuplicate, + layerNumber: dropLayerNumber, + }: HumanData, announceModifierKeys?: boolean ) => { if (announceModifierKeys && (canSwap || canDuplicate)) { return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.moveCompatibleMain', { - defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over position {dropPosition} in {dropGroupLabel} group. Press space or enter to move.{duplicateCopy}{swapCopy}`, + defaultMessage: `You're dragging {label} from {groupLabel} at position {position} over position {dropPosition} in {dropGroupLabel} group in layer {dropLayerNumber}. Press space or enter to move.{duplicateCopy}`, values: { label, groupLabel, @@ -305,69 +344,78 @@ export const announcements: CustomAnnouncementsType = { dropGroupLabel, dropPosition, duplicateCopy: canDuplicate ? DUPLICATE_SHORT : '', - swapCopy: canSwap ? SWAP_SHORT : '', + dropLayerNumber, }, }); } return i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.moveCompatible', { - defaultMessage: `Move {label} to {dropGroupLabel} group at position {dropPosition}. Press space or enter to move`, + defaultMessage: `Move {label} to {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Press space or enter to move`, values: { label, dropGroupLabel, dropPosition, + dropLayerNumber, }, }); }, duplicate_incompatible: ( { label }: HumanData, - { groupLabel, position, nextLabel }: HumanData + { groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.duplicateIncompatible', { defaultMessage: - 'Convert copy of {label} to {nextLabel} and add to {groupLabel} group at position {position}. Hold Alt or Option and press space or enter to duplicate', + 'Convert copy of {label} to {nextLabel} and add to {groupLabel} group at position {position} in layer {dropLayerNumber}. Hold Alt or Option and press space or enter to duplicate', values: { label, groupLabel, position, nextLabel, + dropLayerNumber, }, }), replace_duplicate_incompatible: ( { label }: HumanData, - { label: dropLabel, groupLabel, position, nextLabel }: HumanData + { label: dropLabel, groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateIncompatible', { defaultMessage: - 'Convert copy of {label} to {nextLabel} and replace {dropLabel} in {groupLabel} group at position {position}. Hold Alt or Option and press space or enter to duplicate and replace', + 'Convert copy of {label} to {nextLabel} and replace {dropLabel} in {groupLabel} group at position {position} in layer {dropLayerNumber}. Hold Alt or Option and press space or enter to duplicate and replace', values: { label, groupLabel, position, dropLabel, nextLabel, + dropLayerNumber, }, }), replace_duplicate_compatible: ( { label }: HumanData, - { label: dropLabel, groupLabel, position }: HumanData + { label: dropLabel, groupLabel, position, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateCompatible', { defaultMessage: - 'Duplicate {label} and replace {dropLabel} in {groupLabel} at position {position}. Hold Alt or Option and press space or enter to duplicate and replace', + 'Duplicate {label} and replace {dropLabel} in {groupLabel} at position {position} in layer {dropLayerNumber}. Hold Alt or Option and press space or enter to duplicate and replace', values: { label, dropLabel, groupLabel, position, + dropLayerNumber, }, }), swap_compatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.swapCompatible', { defaultMessage: - 'Swap {label} in {groupLabel} group at position {position} with {dropLabel} in {dropGroupLabel} group at position {dropPosition}. Hold Shift and press space or enter to swap', + 'Swap {label} in {groupLabel} group at position {position} in layer {layerNumber} with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Hold Shift and press space or enter to swap', values: { label, groupLabel, @@ -375,15 +423,23 @@ export const announcements: CustomAnnouncementsType = { dropLabel, dropGroupLabel, dropPosition, + layerNumber, + dropLayerNumber, }, }), swap_incompatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, nextLabel }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + nextLabel, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.swapIncompatible', { defaultMessage: - 'Convert {label} to {nextLabel} in {groupLabel} group at position {position} and swap with {dropLabel} in {dropGroupLabel} group at position {dropPosition}. Hold Shift and press space or enter to swap', + 'Convert {label} to {nextLabel} in {groupLabel} group at position {position} in layer {layerNumber} and swap with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Hold Shift and press space or enter to swap', values: { label, groupLabel, @@ -392,15 +448,22 @@ export const announcements: CustomAnnouncementsType = { dropGroupLabel, dropPosition, nextLabel, + layerNumber, + dropLayerNumber, }, }), combine_compatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, nextLabel }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.combineCompatible', { defaultMessage: - 'Combine {label} in {groupLabel} group at position {position} with {dropLabel} in {dropGroupLabel} group at position {dropPosition}. Hold Control and press space or enter to combine', + 'Combine {label} in {groupLabel} group at position {position} in layer {layerNumber} with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Hold Control and press space or enter to combine', values: { label, groupLabel, @@ -408,15 +471,23 @@ export const announcements: CustomAnnouncementsType = { dropLabel, dropGroupLabel, dropPosition, + layerNumber, + dropLayerNumber, }, }), combine_incompatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, nextLabel }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + nextLabel, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.combineIncompatible', { defaultMessage: - 'Convert {label} to {nextLabel} in {groupLabel} group at position {position} and combine with {dropLabel} in {dropGroupLabel} group at position {dropPosition}. Hold Control and press space or enter to combine', + 'Convert {label} to {nextLabel} in {groupLabel} group at position {position} in layer {layerNumber} and combine with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}. Hold Control and press space or enter to combine', values: { label, groupLabel, @@ -425,6 +496,8 @@ export const announcements: CustomAnnouncementsType = { dropGroupLabel, dropPosition, nextLabel, + dropLayerNumber, + layerNumber, }, }), }, @@ -436,92 +509,110 @@ export const announcements: CustomAnnouncementsType = { replace_compatible: replaceAnnouncement.dropped, replace_incompatible: ( { label }: HumanData, - { label: dropLabel, groupLabel, position, nextLabel }: HumanData + { label: dropLabel, groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.replaceIncompatible', { defaultMessage: - 'Converted {label} to {nextLabel} and replaced {dropLabel} in {groupLabel} group at position {position}', + 'Converted {label} to {nextLabel} and replaced {dropLabel} in {groupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, nextLabel, dropLabel, groupLabel, position, + dropLayerNumber, }, }), - move_incompatible: ({ label }: HumanData, { groupLabel, position, nextLabel }: HumanData) => + move_incompatible: ( + { label }: HumanData, + { groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData + ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.moveIncompatible', { defaultMessage: - 'Converted {label} to {nextLabel} and moved to {groupLabel} group at position {position}', + 'Converted {label} to {nextLabel} and moved to {groupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, nextLabel, groupLabel, position, + dropLayerNumber, }, }), - move_compatible: ({ label }: HumanData, { groupLabel, position }: HumanData) => + move_compatible: ( + { label }: HumanData, + { groupLabel, position, layerNumber: dropLayerNumber }: HumanData + ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.moveCompatible', { - defaultMessage: 'Moved {label} to {groupLabel} group at position {position}', + defaultMessage: + 'Moved {label} to {groupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, groupLabel, position, + dropLayerNumber, }, }), duplicate_incompatible: ( { label }: HumanData, - { groupLabel, position, nextLabel }: HumanData + { groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.duplicateIncompatible', { defaultMessage: - 'Converted copy of {label} to {nextLabel} and added to {groupLabel} group at position {position}', + 'Converted copy of {label} to {nextLabel} and added to {groupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, groupLabel, position, nextLabel, + dropLayerNumber, }, }), replace_duplicate_incompatible: ( { label }: HumanData, - { label: dropLabel, groupLabel, position, nextLabel }: HumanData + { label: dropLabel, groupLabel, position, nextLabel, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.replaceDuplicateIncompatible', { defaultMessage: - 'Converted copy of {label} to {nextLabel} and replaced {dropLabel} in {groupLabel} group at position {position}', + 'Converted copy of {label} to {nextLabel} and replaced {dropLabel} in {groupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, dropLabel, groupLabel, position, nextLabel, + dropLayerNumber, }, }), replace_duplicate_compatible: ( { label }: HumanData, - { label: dropLabel, groupLabel, position }: HumanData + { label: dropLabel, groupLabel, position, layerNumber: dropLayerNumber }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.duplicated.replaceDuplicateCompatible', { defaultMessage: - 'Replaced {dropLabel} with a copy of {label} in {groupLabel} at position {position}', + 'Replaced {dropLabel} with a copy of {label} in {groupLabel} at position {position} in layer {dropLayerNumber}', values: { label, dropLabel, groupLabel, position, + dropLayerNumber, }, }), swap_compatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.swapCompatible', { defaultMessage: - 'Moved {label} to {dropGroupLabel} at position {dropPosition} and {dropLabel} to {groupLabel} group at position {position}', + 'Moved {label} to {dropGroupLabel} at position {dropPosition} in layer {dropLayerNumber} and {dropLabel} to {groupLabel} group at position {position} in layer {layerNumber}', values: { label, groupLabel, @@ -529,15 +620,23 @@ export const announcements: CustomAnnouncementsType = { dropLabel, dropGroupLabel, dropPosition, + layerNumber, + dropLayerNumber, }, }), swap_incompatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, nextLabel }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + nextLabel, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.swapIncompatible', { defaultMessage: - 'Converted {label} to {nextLabel} in {groupLabel} group at position {position} and swapped with {dropLabel} in {dropGroupLabel} group at position {dropPosition}', + 'Converted {label} to {nextLabel} in {groupLabel} group at position {position} in layer {layerNumber} and swapped with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}', values: { label, groupLabel, @@ -546,31 +645,44 @@ export const announcements: CustomAnnouncementsType = { dropLabel, dropPosition, nextLabel, + dropLayerNumber, + layerNumber, }, }), combine_compatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition }: HumanData + { label, groupLabel }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.combineCompatible', { defaultMessage: - 'Combined {label} to {dropGroupLabel} at position {dropPosition} and {dropLabel} to {groupLabel} group at position {position}', + 'Combined {label} in group {groupLabel} to {dropLabel} in group {dropGroupLabel} at position {dropPosition} in layer {dropLayerNumber}', values: { label, groupLabel, - position, dropLabel, dropGroupLabel, dropPosition, + dropLayerNumber, }, }), combine_incompatible: ( - { label, groupLabel, position }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position: dropPosition, nextLabel }: HumanData + { label, groupLabel, position, layerNumber }: HumanData, + { + label: dropLabel, + groupLabel: dropGroupLabel, + position: dropPosition, + nextLabel, + layerNumber: dropLayerNumber, + }: HumanData ) => i18n.translate('xpack.lens.dragDrop.announce.dropped.combineIncompatible', { defaultMessage: - 'Converted {label} to {nextLabel} in {groupLabel} group at position {position} and combined with {dropLabel} in {dropGroupLabel} group at position {dropPosition}', + 'Converted {label} to {nextLabel} in {groupLabel} group at position {position} and combined with {dropLabel} in {dropGroupLabel} group at position {dropPosition} in layer {dropLayerNumber}', values: { label, groupLabel, @@ -579,6 +691,7 @@ export const announcements: CustomAnnouncementsType = { dropLabel, dropPosition, nextLabel, + dropLayerNumber, }, }), }, @@ -620,15 +733,22 @@ const defaultAnnouncements = { dropped: ( { label }: HumanData, - { groupLabel: dropGroupLabel, position, label: dropLabel }: HumanData + { + groupLabel: dropGroupLabel, + position, + label: dropLabel, + layerNumber: dropLayerNumber, + }: HumanData ) => dropGroupLabel && position ? i18n.translate('xpack.lens.dragDrop.announce.droppedDefault', { - defaultMessage: 'Added {label} in {dropGroupLabel} group at position {position}', + defaultMessage: + 'Added {label} in {dropGroupLabel} group at position {position} in layer {dropLayerNumber}', values: { label, dropGroupLabel, position, + dropLayerNumber, }, }) : i18n.translate('xpack.lens.dragDrop.announce.droppedNoPosition', { @@ -640,15 +760,21 @@ const defaultAnnouncements = { }), selectedTarget: ( { label }: HumanData, - { label: dropLabel, groupLabel: dropGroupLabel, position }: HumanData + { + label: dropLabel, + groupLabel: dropGroupLabel, + position, + layerNumber: dropLayerNumber, + }: HumanData ) => { return dropGroupLabel && position ? i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.default', { - defaultMessage: `Add {label} to {dropGroupLabel} group at position {position}. Press space or enter to add`, + defaultMessage: `Add {label} to {dropGroupLabel} group at position {position} in layer {dropLayerNumber}. Press space or enter to add`, values: { label, dropGroupLabel, position, + dropLayerNumber, }, }) : i18n.translate('xpack.lens.dragDrop.announce.selectedTarget.defaultNoPosition', { @@ -671,8 +797,15 @@ export const announce = { dropElement: HumanData, type?: DropType, announceModifierKeys?: boolean - ) => - (type && - announcements.selectedTarget?.[type]?.(draggedElement, dropElement, announceModifierKeys)) || - defaultAnnouncements.selectedTarget(draggedElement, dropElement), + ) => { + return ( + (type && + announcements.selectedTarget?.[type]?.( + draggedElement, + dropElement, + announceModifierKeys + )) || + defaultAnnouncements.selectedTarget(draggedElement, dropElement) + ); + }, }; diff --git a/x-pack/plugins/lens/public/drag_drop/providers/types.tsx b/x-pack/plugins/lens/public/drag_drop/providers/types.tsx index 921ab897706c0..363f0b41ef3a1 100644 --- a/x-pack/plugins/lens/public/drag_drop/providers/types.tsx +++ b/x-pack/plugins/lens/public/drag_drop/providers/types.tsx @@ -10,6 +10,7 @@ import { DropType } from '../../types'; export interface HumanData { label: string; groupLabel?: string; + layerNumber?: number; position?: number; nextLabel?: string; canSwap?: boolean; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/draggable_dimension_button.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/draggable_dimension_button.tsx index f0e0911b708fd..32aba270e846b 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/draggable_dimension_button.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/draggable_dimension_button.tsx @@ -10,10 +10,10 @@ import { DragDrop, DragDropIdentifier, DragContext } from '../../../../drag_drop import { Datasource, VisualizationDimensionGroupConfig, - isDraggedOperation, + isOperation, DropType, + DatasourceLayers, } from '../../../../types'; -import { LayerDatasourceDropProps } from '../types'; import { getCustomDropTarget, getAdditionalClassesOnDroppable, @@ -29,45 +29,53 @@ export function DraggableDimensionButton({ layerIndex, columnId, group, - groups, onDrop, onDragStart, onDragEnd, children, - layerDatasourceDropProps, + state, layerDatasource, + datasourceLayers, registerNewButtonRef, }: { layerId: string; groupIndex: number; layerIndex: number; - onDrop: ( - droppedItem: DragDropIdentifier, - dropTarget: DragDropIdentifier, - dropType?: DropType - ) => void; + onDrop: (source: DragDropIdentifier, dropTarget: DragDropIdentifier, dropType?: DropType) => void; onDragStart: () => void; onDragEnd: () => void; group: VisualizationDimensionGroupConfig; - groups: VisualizationDimensionGroupConfig[]; label: string; children: ReactElement; layerDatasource: Datasource; - layerDatasourceDropProps: LayerDatasourceDropProps; + datasourceLayers: DatasourceLayers; + state: unknown; accessorIndex: number; columnId: string; registerNewButtonRef: (id: string, instance: HTMLDivElement | null) => void; }) { const { dragging } = useContext(DragContext); - const dropProps = getDropProps(layerDatasource, { - ...(layerDatasourceDropProps || {}), - dragging, - columnId, - filterOperations: group.filterOperations, - groupId: group.groupId, - dimensionGroups: groups, - }); + const sharedDatasource = + !isOperation(dragging) || + datasourceLayers?.[dragging.layerId]?.datasourceId === datasourceLayers?.[layerId]?.datasourceId + ? layerDatasource + : undefined; + + const dropProps = getDropProps( + { + state, + source: dragging, + target: { + layerId, + columnId, + groupId: group.groupId, + filterOperations: group.filterOperations, + prioritizedOperation: group.prioritizedOperation, + }, + }, + sharedDatasource + ); const dropTypes = dropProps?.dropTypes; const nextLabel = dropProps?.nextLabel; @@ -104,6 +112,7 @@ export function DraggableDimensionButton({ groupLabel: group.groupLabel, position: accessorIndex + 1, nextLabel: nextLabel || '', + layerNumber: layerIndex + 1, }, }), [ @@ -118,10 +127,10 @@ export function DraggableDimensionButton({ canDuplicate, canSwap, canCombine, + layerIndex, ] ); - // todo: simplify by id and use drop targets? const reorderableGroup = useMemo( () => group.accessors.map((g) => ({ @@ -136,7 +145,7 @@ export function DraggableDimensionButton({ ); const handleOnDrop = useCallback( - (droppedItem, selectedDropType) => onDrop(droppedItem, value, selectedDropType), + (source, selectedDropType) => onDrop(source, value, selectedDropType), [value, onDrop] ); return ( @@ -151,7 +160,7 @@ export function DraggableDimensionButton({ getAdditionalClassesOnDroppable={getAdditionalClassesOnDroppable} order={[2, layerIndex, groupIndex, accessorIndex]} draggable - dragType={isDraggedOperation(dragging) ? 'move' : 'copy'} + dragType={isOperation(dragging) ? 'move' : 'copy'} dropTypes={dropTypes} reorderableGroup={reorderableGroup.length > 1 ? reorderableGroup : undefined} value={value} diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.test.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.test.tsx new file mode 100644 index 0000000000000..dd5ec847fb5b5 --- /dev/null +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.test.tsx @@ -0,0 +1,123 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { getDropProps } from './drop_targets_utils'; +import { createMockDatasource } from '../../../../mocks'; + +describe('getDropProps', () => { + it('should run datasource getDropProps if exists', () => { + const mockDatasource = createMockDatasource('testDatasource'); + getDropProps( + { + state: 'datasourceState', + target: { + columnId: 'col1', + groupId: 'x', + layerId: 'first', + filterOperations: () => true, + }, + source: { + columnId: 'col1', + groupId: 'x', + layerId: 'first', + id: 'annotationColumn2', + humanData: { label: 'Event' }, + }, + }, + mockDatasource + ); + expect(mockDatasource.getDropProps).toHaveBeenCalled(); + }); + describe('no datasource', () => { + it('returns reorder for the same group existing columns', () => { + expect( + getDropProps({ + state: 'datasourceState', + target: { + columnId: 'annotationColumn', + groupId: 'xAnnotations', + layerId: 'second', + filterOperations: () => true, + }, + source: { + columnId: 'annotationColumn2', + groupId: 'xAnnotations', + layerId: 'second', + id: 'annotationColumn2', + humanData: { label: 'Event' }, + }, + }) + ).toEqual({ dropTypes: ['reorder'] }); + }); + it('returns duplicate for the same group existing column and not existing column', () => { + expect( + getDropProps({ + state: 'datasourceState', + target: { + columnId: 'annotationColumn', + groupId: 'xAnnotations', + layerId: 'second', + isNewColumn: true, + filterOperations: () => true, + }, + source: { + columnId: 'annotationColumn2', + groupId: 'xAnnotations', + layerId: 'second', + id: 'annotationColumn2', + humanData: { label: 'Event' }, + }, + }) + ).toEqual({ dropTypes: ['duplicate_compatible'] }); + }); + it('returns replace_duplicate and replace for replacing to different layer', () => { + expect( + getDropProps({ + state: 'datasourceState', + target: { + columnId: 'annotationColumn', + groupId: 'xAnnotations', + layerId: 'first', + filterOperations: () => true, + }, + source: { + columnId: 'annotationColumn2', + groupId: 'xAnnotations', + layerId: 'second', + id: 'annotationColumn2', + humanData: { label: 'Event' }, + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible', 'swap_compatible'], + }); + }); + it('returns duplicate and move for replacing to different layer for empty column', () => { + expect( + getDropProps({ + state: 'datasourceState', + target: { + columnId: 'annotationColumn', + groupId: 'xAnnotations', + layerId: 'first', + isNewColumn: true, + filterOperations: () => true, + }, + source: { + columnId: 'annotationColumn2', + groupId: 'xAnnotations', + layerId: 'second', + id: 'annotationColumn2', + humanData: { label: 'Event' }, + }, + }) + ).toEqual({ + dropTypes: ['move_compatible', 'duplicate_compatible'], + }); + }); + }); +}); diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.tsx index 056efbf379d8a..8ce2a4c0cc975 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils.tsx @@ -9,8 +9,17 @@ import React from 'react'; import classNames from 'classnames'; import { EuiIcon, EuiFlexItem, EuiFlexGroup, EuiText } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { DraggingIdentifier } from '../../../../drag_drop'; -import { Datasource, DropType, GetDropProps } from '../../../../types'; +import { DragDropIdentifier, DraggingIdentifier } from '../../../../drag_drop'; +import { + Datasource, + DropType, + FramePublicAPI, + GetDropPropsArgs, + isOperation, + Visualization, + DragDropOperation, + VisualizationDimensionGroupConfig, +} from '../../../../types'; function getPropsForDropType(type: 'swap' | 'duplicate' | 'combine') { switch (type) { @@ -131,35 +140,97 @@ export const getAdditionalClassesOnDroppable = (dropType?: string) => { } }; -const isOperationFromTheSameGroup = ( - op1?: DraggingIdentifier, - op2?: { layerId: string; groupId: string; columnId: string } -) => { +const isOperationFromCompatibleGroup = (op1?: DraggingIdentifier, op2?: DragDropOperation) => { return ( - op1 && - op2 && - 'columnId' in op1 && + isOperation(op1) && + isOperation(op2) && + op1.columnId !== op2.columnId && + op1.groupId === op2.groupId && + op1.layerId !== op2.layerId + ); +}; + +export const isOperationFromTheSameGroup = (op1?: DraggingIdentifier, op2?: DragDropOperation) => { + return ( + isOperation(op1) && + isOperation(op2) && op1.columnId !== op2.columnId && - 'groupId' in op1 && op1.groupId === op2.groupId && - 'layerId' in op1 && op1.layerId === op2.layerId ); }; +export function getDropPropsForSameGroup( + isNewColumn?: boolean +): { dropTypes: DropType[]; nextLabel?: string } | undefined { + return !isNewColumn ? { dropTypes: ['reorder'] } : { dropTypes: ['duplicate_compatible'] }; +} + export const getDropProps = ( - layerDatasource: Datasource, - dropProps: GetDropProps, - isNew?: boolean + dropProps: GetDropPropsArgs, + sharedDatasource?: Datasource ): { dropTypes: DropType[]; nextLabel?: string } | undefined => { - if (layerDatasource) { - return layerDatasource.getDropProps(dropProps); + if (sharedDatasource) { + return sharedDatasource?.getDropProps(dropProps); } else { - // TODO: refactor & test this - it's too annotations specific - // TODO: allow moving operations between layers for annotations - if (isOperationFromTheSameGroup(dropProps.dragging, dropProps)) { - return { dropTypes: [isNew ? 'duplicate_compatible' : 'reorder'], nextLabel: '' }; + if (isOperationFromTheSameGroup(dropProps.source, dropProps.target)) { + return getDropPropsForSameGroup(dropProps.target.isNewColumn); + } + if (isOperationFromCompatibleGroup(dropProps.source, dropProps.target)) { + return { + dropTypes: dropProps.target.isNewColumn + ? ['move_compatible', 'duplicate_compatible'] + : ['replace_compatible', 'replace_duplicate_compatible', 'swap_compatible'], + }; } } return; }; + +export interface OnVisDropProps { + prevState: T; + target: DragDropOperation; + source: DragDropIdentifier; + frame: FramePublicAPI; + dropType: DropType; + group?: VisualizationDimensionGroupConfig; +} + +export function onDropForVisualization( + props: OnVisDropProps, + activeVisualization: Visualization +) { + const { prevState, target, frame, dropType, source, group } = props; + const { layerId, columnId, groupId } = target; + + const previousColumn = + isOperation(source) && group?.requiresPreviousColumnOnDuplicate ? source.columnId : undefined; + + const newVisState = activeVisualization.setDimension({ + columnId, + groupId, + layerId, + prevState, + previousColumn, + frame, + }); + + // remove source + if ( + isOperation(source) && + (dropType === 'move_compatible' || + dropType === 'move_incompatible' || + dropType === 'combine_incompatible' || + dropType === 'combine_compatible' || + dropType === 'replace_compatible' || + dropType === 'replace_incompatible') + ) { + return activeVisualization.removeDimension({ + columnId: source?.columnId, + layerId: source?.layerId, + prevState: newVisState, + frame, + }); + } + return newVisState; +} diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/empty_dimension_button.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/empty_dimension_button.tsx index 867ce32ea700e..a35366611ae18 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/empty_dimension_button.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/buttons/empty_dimension_button.tsx @@ -12,8 +12,13 @@ import { i18n } from '@kbn/i18n'; import { generateId } from '../../../../id_generator'; import { DragDrop, DragDropIdentifier, DragContext } from '../../../../drag_drop'; -import { Datasource, VisualizationDimensionGroupConfig, DropType } from '../../../../types'; -import { LayerDatasourceDropProps } from '../types'; +import { + Datasource, + VisualizationDimensionGroupConfig, + DropType, + DatasourceLayers, + isOperation, +} from '../../../../types'; import { getCustomDropTarget, getAdditionalClassesOnDroppable, @@ -98,31 +103,31 @@ const SuggestedValueButton = ({ columnId, group, onClick }: EmptyButtonProps) => export function EmptyDimensionButton({ group, - groups, layerDatasource, - layerDatasourceDropProps, + state, layerId, groupIndex, layerIndex, onClick, onDrop, + datasourceLayers, }: { layerId: string; groupIndex: number; layerIndex: number; - onDrop: ( - droppedItem: DragDropIdentifier, - dropTarget: DragDropIdentifier, - dropType?: DropType - ) => void; + onDrop: (source: DragDropIdentifier, dropTarget: DragDropIdentifier, dropType?: DropType) => void; onClick: (id: string) => void; group: VisualizationDimensionGroupConfig; - groups: VisualizationDimensionGroupConfig[]; - layerDatasource: Datasource; - layerDatasourceDropProps: LayerDatasourceDropProps; + datasourceLayers: DatasourceLayers; + state: unknown; }) { const { dragging } = useContext(DragContext); + const sharedDatasource = + !isOperation(dragging) || + datasourceLayers?.[dragging.layerId]?.datasourceId === datasourceLayers?.[layerId]?.datasourceId + ? layerDatasource + : undefined; const itemIndex = group.accessors.length; @@ -132,16 +137,19 @@ export function EmptyDimensionButton({ }, [itemIndex]); const dropProps = getDropProps( - layerDatasource, { - ...(layerDatasourceDropProps || {}), - dragging, - columnId: newColumnId, - filterOperations: group.filterOperations, - groupId: group.groupId, - dimensionGroups: groups, + state, + source: dragging, + target: { + layerId, + columnId: newColumnId, + groupId: group.groupId, + filterOperations: group.filterOperations, + prioritizedOperation: group.prioritizedOperation, + isNewColumn: true, + }, }, - true + sharedDatasource ); const dropTypes = dropProps?.dropTypes; @@ -157,6 +165,7 @@ export function EmptyDimensionButton({ columnId: newColumnId, groupId: group.groupId, layerId, + filterOperations: group.filterOperations, id: newColumnId, humanData: { label, @@ -164,13 +173,24 @@ export function EmptyDimensionButton({ position: itemIndex + 1, nextLabel: nextLabel || '', canDuplicate, + layerNumber: layerIndex + 1, }, }), - [newColumnId, group.groupId, layerId, group.groupLabel, itemIndex, nextLabel, canDuplicate] + [ + newColumnId, + group.groupId, + layerId, + group.groupLabel, + group.filterOperations, + itemIndex, + nextLabel, + canDuplicate, + layerIndex, + ] ); const handleOnDrop = React.useCallback( - (droppedItem, selectedDropType) => onDrop(droppedItem, value, selectedDropType), + (source, selectedDropType) => onDrop(source, value, selectedDropType), [value, onDrop] ); diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx index e5da3b0feef03..02c5f1c23967f 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.test.tsx @@ -631,7 +631,7 @@ describe('LayerPanel', () => { expect(mockDatasource.getDropProps).toHaveBeenCalledWith( expect.objectContaining({ - dragging: draggingField, + source: draggingField, }) ); @@ -644,7 +644,7 @@ describe('LayerPanel', () => { expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ - droppedItem: draggingField, + source: draggingField, }) ); }); @@ -663,8 +663,8 @@ describe('LayerPanel', () => { ], }); - mockDatasource.getDropProps.mockImplementation(({ columnId }) => - columnId !== 'a' ? { dropTypes: ['field_replace'], nextLabel: '' } : undefined + mockDatasource.getDropProps.mockImplementation(({ target }) => + target.columnId !== 'a' ? { dropTypes: ['field_replace'], nextLabel: '' } : undefined ); const { instance } = await mountWithProvider( @@ -674,7 +674,9 @@ describe('LayerPanel', () => { ); expect(mockDatasource.getDropProps).toHaveBeenCalledWith( - expect.objectContaining({ columnId: 'a' }) + expect.objectContaining({ + target: expect.objectContaining({ columnId: 'a', groupId: 'a', layerId: 'first' }), + }) ); expect( @@ -741,7 +743,7 @@ describe('LayerPanel', () => { expect(mockDatasource.getDropProps).toHaveBeenCalledWith( expect.objectContaining({ - dragging: draggingOperation, + source: draggingOperation, }) ); @@ -755,8 +757,8 @@ describe('LayerPanel', () => { expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ - columnId: 'b', - droppedItem: draggingOperation, + target: expect.objectContaining({ columnId: 'b' }), + source: draggingOperation, }) ); @@ -771,8 +773,8 @@ describe('LayerPanel', () => { expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ - columnId: 'newid', - droppedItem: draggingOperation, + target: expect.objectContaining({ columnId: 'newid' }), + source: draggingOperation, }) ); }); @@ -816,7 +818,7 @@ describe('LayerPanel', () => { expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ dropType: 'reorder', - droppedItem: draggingOperation, + source: draggingOperation, }) ); const secondButton = instance @@ -865,9 +867,9 @@ describe('LayerPanel', () => { }); expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ - columnId: 'newid', + target: expect.objectContaining({ columnId: 'newid' }), dropType: 'duplicate_compatible', - droppedItem: draggingOperation, + source: draggingOperation, }) ); }); @@ -907,7 +909,7 @@ describe('LayerPanel', () => { humanData: { label: 'Label' }, }; - mockDatasource.onDrop.mockReturnValue({ deleted: 'a' }); + mockDatasource.onDrop.mockReturnValue(true); const updateVisualization = jest.fn(); const { instance } = await mountWithProvider( @@ -925,9 +927,10 @@ describe('LayerPanel', () => { expect(mockDatasource.onDrop).toHaveBeenCalledWith( expect.objectContaining({ dropType: 'replace_compatible', - droppedItem: draggingOperation, + source: draggingOperation, }) ); + // testing default onDropForVisualization path expect(mockVis.setDimension).toHaveBeenCalledWith( expect.objectContaining({ columnId: 'c', @@ -945,6 +948,85 @@ describe('LayerPanel', () => { ); expect(updateVisualization).toHaveBeenCalledTimes(1); }); + it('should call onDrop and update visualization when replacing between compatible groups2', async () => { + const mockVis = { + ...mockVisualization, + removeDimension: jest.fn(), + setDimension: jest.fn(() => 'modifiedState'), + onDrop: jest.fn(() => 'modifiedState'), + }; + jest.spyOn(mockVis.onDrop, 'bind').mockImplementation((thisVal, ...args) => mockVis.onDrop); + + mockVis.getConfiguration.mockReturnValue({ + groups: [ + { + groupLabel: 'A', + groupId: 'a', + accessors: [{ columnId: 'a' }, { columnId: 'b' }], + filterOperations: () => true, + supportsMoreColumns: true, + dataTestSubj: 'lnsGroup', + }, + { + groupLabel: 'B', + groupId: 'b', + accessors: [{ columnId: 'c' }], + filterOperations: () => true, + supportsMoreColumns: true, + dataTestSubj: 'lnsGroup2', + }, + ], + }); + + const draggingOperation = { + layerId: 'first', + columnId: 'a', + groupId: 'a', + id: 'a', + humanData: { label: 'Label' }, + }; + + mockDatasource.onDrop.mockReturnValue(true); + const updateVisualization = jest.fn(); + + const { instance } = await mountWithProvider( + + + + ); + act(() => { + instance.find(DragDrop).at(3).prop('onDrop')!(draggingOperation, 'replace_compatible'); + }); + + expect(mockDatasource.onDrop).toHaveBeenCalledWith( + expect.objectContaining({ + dropType: 'replace_compatible', + source: draggingOperation, + }) + ); + + expect(mockVis.onDrop).toHaveBeenCalledWith( + expect.objectContaining({ + dropType: 'replace_compatible', + prevState: 'state', + source: draggingOperation, + target: expect.objectContaining({ + columnId: 'c', + groupId: 'b', + id: 'c', + layerId: 'first', + }), + }), + mockVis + ); + expect(mockVis.setDimension).not.toHaveBeenCalled(); + expect(mockVis.removeDimension).not.toHaveBeenCalled(); + expect(updateVisualization).toHaveBeenCalledTimes(1); + }); }); describe('add a new dimension', () => { diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx index c577bf89d6bd1..0c54ca0df5c71 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx @@ -19,7 +19,13 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { NativeRenderer } from '../../../native_renderer'; -import { StateSetter, Visualization, DraggedOperation, DropType } from '../../../types'; +import { + StateSetter, + Visualization, + DragDropOperation, + DropType, + isOperation, +} from '../../../types'; import { DragDropIdentifier, ReorderProvider } from '../../../drag_drop'; import { LayerSettings } from './layer_settings'; import { trackUiEvent } from '../../../lens_ui_telemetry'; @@ -36,6 +42,7 @@ import { selectResolvedDateRange, selectDatasourceStates, } from '../../../state_management'; +import { onDropForVisualization } from './buttons/drop_targets_utils'; const initialActiveDimensionState = { isNew: false, @@ -109,19 +116,12 @@ export function LayerPanel( const layerDatasourceState = datasourceStates?.[datasourceId]?.state; const layerDatasource = props.datasourceMap[datasourceId]; - const layerDatasourceDropProps = useMemo( - () => ({ - layerId, - state: layerDatasourceState, - setState: (newState: unknown) => { - updateDatasource(datasourceId, newState); - }, - }), - [layerId, layerDatasourceState, datasourceId, updateDatasource] - ); - const layerDatasourceConfigProps = { - ...layerDatasourceDropProps, + state: layerDatasourceState, + setState: (newState: unknown) => { + updateDatasource(datasourceId, newState); + }, + layerId, frame: props.framePublicAPI, dateRange, }; @@ -155,105 +155,70 @@ export function LayerPanel( registerNewRef: registerNewButtonRef, } = useFocusUpdate(allAccessors); - const layerDatasourceOnDrop = layerDatasource?.onDrop; - const onDrop = useMemo(() => { - return ( - droppedItem: DragDropIdentifier, - targetItem: DragDropIdentifier, - dropType?: DropType - ) => { + return (source: DragDropIdentifier, target: DragDropIdentifier, dropType?: DropType) => { if (!dropType) { return; } - const { - columnId, - groupId, - layerId: targetLayerId, - } = targetItem as unknown as DraggedOperation; + if (!isOperation(target)) { + throw new Error('Drop target should be an operation'); + } + if (dropType === 'reorder' || dropType === 'field_replace' || dropType === 'field_add') { - setNextFocusedButtonId(droppedItem.id); + setNextFocusedButtonId(source.id); } else { - setNextFocusedButtonId(columnId); + setNextFocusedButtonId(target.columnId); } + let hasDropSucceeded = true; if (layerDatasource) { - const group = groups.find(({ groupId: gId }) => gId === groupId); - const filterOperations = group?.filterOperations || (() => false); - const dropResult = layerDatasourceOnDrop({ - ...layerDatasourceDropProps, - droppedItem, - columnId, - layerId: targetLayerId, - filterOperations, - dimensionGroups: groups, - groupId, - dropType, - }); - if (dropResult) { - let previousColumn = - typeof droppedItem.column === 'string' ? droppedItem.column : undefined; - - // make it inherit only for moving and duplicate - if (!previousColumn) { - // when duplicating check if the previous column is required - if ( - dropType === 'duplicate_compatible' && - typeof droppedItem.columnId === 'string' && - group?.requiresPreviousColumnOnDuplicate - ) { - previousColumn = droppedItem.columnId; - } else { - previousColumn = typeof dropResult === 'object' ? dropResult.deleted : undefined; - } - } - const newVisState = activeVisualization.setDimension({ - columnId, - groupId, - layerId: targetLayerId, - prevState: props.visualizationState, - previousColumn, - frame: framePublicAPI, - }); + hasDropSucceeded = Boolean( + layerDatasource?.onDrop({ + state: layerDatasourceState, + setState: (newState: unknown) => { + updateDatasource(datasourceId, newState); + }, + source, + target: { + ...(target as unknown as DragDropOperation), + filterOperations: + groups.find(({ groupId: gId }) => gId === target.groupId)?.filterOperations || + Boolean, + }, + dimensionGroups: groups, + dropType, + }) + ); + } + if (hasDropSucceeded) { + activeVisualization.onDrop = activeVisualization.onDrop?.bind(activeVisualization); - if (typeof dropResult === 'object') { - // When a column is moved, we delete the reference to the old - updateVisualization( - activeVisualization.removeDimension({ - columnId: dropResult.deleted, - layerId: targetLayerId, - prevState: newVisState, - frame: framePublicAPI, - }) - ); - } else { - updateVisualization(newVisState); - } - } - } else { - if (dropType === 'duplicate_compatible' || dropType === 'reorder') { - const newVisState = activeVisualization.setDimension({ - columnId, - groupId, - layerId: targetLayerId, - prevState: props.visualizationState, - previousColumn: droppedItem.id, - frame: framePublicAPI, - }); - updateVisualization(newVisState); - } + updateVisualization( + (activeVisualization.onDrop || onDropForVisualization)?.( + { + prevState: props.visualizationState, + frame: framePublicAPI, + target, + source, + dropType, + group: groups.find(({ groupId: gId }) => gId === target.groupId), + }, + activeVisualization + ) + ); } }; }, [ layerDatasource, + layerDatasourceState, setNextFocusedButtonId, groups, - layerDatasourceOnDrop, - layerDatasourceDropProps, activeVisualization, props.visualizationState, framePublicAPI, updateVisualization, + datasourceId, + updateDatasource, ]); const isDimensionPanelOpen = Boolean(activeId); @@ -462,15 +427,15 @@ export function LayerPanel( return ( setHideTooltip(true)} @@ -562,12 +527,12 @@ export function LayerPanel( {group.supportsMoreColumns ? ( { props.onEmptyDimensionAdd(id, group); setActiveDimension({ diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts index 66a30b0a405e8..172e0702f56e8 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts @@ -29,7 +29,6 @@ export interface LayerPanelProps { } export interface LayerDatasourceDropProps { - layerId: string; state: unknown; setState: (newState: unknown) => void; } diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.test.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.test.tsx index c85d2b4d7fbad..cc2397b820a91 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.test.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.test.tsx @@ -134,7 +134,7 @@ describe('workspace_panel', () => { instance = mounted.instance; instance.update(); - expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(2); + expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(3); expect(instance.find(expressionRendererMock)).toHaveLength(0); }); @@ -152,7 +152,7 @@ describe('workspace_panel', () => { instance = mounted.instance; instance.update(); - expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(2); + expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(3); expect(instance.find(expressionRendererMock)).toHaveLength(0); }); @@ -174,7 +174,7 @@ describe('workspace_panel', () => { instance = mounted.instance; instance.update(); - expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(2); + expect(instance.find('[data-test-subj="workspace-drag-drop-prompt"]')).toHaveLength(3); expect(instance.find(expressionRendererMock)).toHaveLength(0); }); diff --git a/x-pack/plugins/lens/public/expressions.ts b/x-pack/plugins/lens/public/expressions.ts index 868d947464e5f..a5f193d63e4f3 100644 --- a/x-pack/plugins/lens/public/expressions.ts +++ b/x-pack/plugins/lens/public/expressions.ts @@ -8,7 +8,7 @@ import type { ExpressionsSetup } from '@kbn/expressions-plugin/public'; import { getDatatable } from '../common/expressions/datatable/datatable'; import { datatableColumn } from '../common/expressions/datatable/datatable_column'; -import { renameColumns } from '../common/expressions/rename_columns/rename_columns'; +import { mapToColumns } from '../common/expressions/map_to_columns/map_to_columns'; import { formatColumn } from '../common/expressions/format_column'; import { counterRate } from '../common/expressions/counter_rate'; import { getTimeScale } from '../common/expressions/time_scale/time_scale'; @@ -24,7 +24,7 @@ export const setupExpressions = ( collapse, counterRate, formatColumn, - renameColumns, + mapToColumns, datatableColumn, getDatatable(formatFactory), getTimeScale(getDatatableUtilities, getTimeZone), diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts deleted file mode 100644 index 66714f494bf53..0000000000000 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts +++ /dev/null @@ -1,2332 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; -import { DataPublicPluginStart } from '@kbn/data-plugin/public'; -import type { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; -import { IndexPatternDimensionEditorProps } from '../dimension_panel'; -import { onDrop } from './on_drop_handler'; -import { getDropProps } from './get_drop_props'; -import { - IUiSettingsClient, - SavedObjectsClientContract, - HttpSetup, - CoreSetup, -} from '@kbn/core/public'; -import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; -import { IndexPatternLayer, IndexPatternPrivateState } from '../../types'; -import { documentField } from '../../document_field'; -import { OperationMetadata, DropType } from '../../../types'; -import { - DateHistogramIndexPatternColumn, - GenericIndexPatternColumn, - MedianIndexPatternColumn, - TermsIndexPatternColumn, -} from '../../operations'; -import { getFieldByNameFactory } from '../../pure_helpers'; -import { generateId } from '../../../id_generator'; -import { layerTypes } from '../../../../common'; - -jest.mock('../../../id_generator'); - -const fields = [ - { - name: 'timestamp', - displayName: 'timestampLabel', - type: 'date', - aggregatable: true, - searchable: true, - exists: true, - }, - { - name: 'bytes', - displayName: 'bytes', - type: 'number', - aggregatable: true, - searchable: true, - exists: true, - }, - { - name: 'memory', - displayName: 'memory', - type: 'number', - aggregatable: true, - searchable: true, - exists: true, - }, - { - name: 'source', - displayName: 'source', - type: 'string', - aggregatable: true, - searchable: true, - exists: true, - }, - { - name: 'src', - displayName: 'src', - type: 'string', - aggregatable: true, - searchable: true, - exists: true, - }, - { - name: 'dest', - displayName: 'dest', - type: 'string', - aggregatable: true, - searchable: true, - exists: true, - }, - documentField, -]; - -const expectedIndexPatterns = { - foo: { - id: 'foo', - title: 'my-fake-index-pattern', - timeFieldName: 'timestamp', - hasExistence: true, - hasRestrictions: false, - fields, - getFieldByName: getFieldByNameFactory(fields), - }, -}; - -const dimensionGroups = [ - { - accessors: [], - groupId: 'a', - supportsMoreColumns: true, - hideGrouping: true, - groupLabel: '', - filterOperations: (op: OperationMetadata) => op.isBucketed, - }, - { - accessors: [{ columnId: 'col1' }, { columnId: 'col2' }, { columnId: 'col3' }], - groupId: 'b', - supportsMoreColumns: true, - hideGrouping: true, - groupLabel: '', - filterOperations: (op: OperationMetadata) => op.isBucketed, - }, - { - accessors: [{ columnId: 'col4' }], - groupId: 'c', - supportsMoreColumns: true, - hideGrouping: true, - groupLabel: '', - filterOperations: (op: OperationMetadata) => op.isBucketed === false, - }, -]; - -const oneColumnLayer: IndexPatternLayer = { - indexPatternId: 'foo', - columnOrder: ['col1'], - columns: { - col1: { - label: 'Date histogram of timestamp', - customLabel: true, - dataType: 'date', - isBucketed: true, - - // Private - operationType: 'date_histogram', - params: { - interval: '1d', - }, - sourceField: 'timestamp', - } as DateHistogramIndexPatternColumn, - }, - incompleteColumns: {}, -}; - -const multipleColumnsLayer: IndexPatternLayer = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3', 'col4'], - columns: { - col1: oneColumnLayer.columns.col1, - col2: { - label: 'Top 10 values of src', - dataType: 'string', - isBucketed: true, - // Private - operationType: 'terms', - params: { - orderBy: { type: 'alphabetical' }, - orderDirection: 'desc', - size: 10, - }, - sourceField: 'src', - } as TermsIndexPatternColumn, - col3: { - label: 'Top 10 values of dest', - dataType: 'string', - isBucketed: true, - - // Private - operationType: 'terms', - params: { - orderBy: { type: 'alphabetical' }, - orderDirection: 'desc', - size: 10, - }, - sourceField: 'dest', - } as TermsIndexPatternColumn, - col4: { - label: 'Median of bytes', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'median', - sourceField: 'bytes', - }, - }, -}; - -const draggingField = { - field: { type: 'number', name: 'bytes', aggregatable: true }, - indexPatternId: 'foo', - id: 'bar', - humanData: { label: 'Label' }, -}; - -const draggingCol1 = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Column 1' }, -}; - -const draggingCol2 = { - columnId: 'col2', - groupId: 'b', - layerId: 'first', - id: 'col2', - humanData: { label: 'Column 2' }, - filterOperations: (op: OperationMetadata) => op.isBucketed, -}; - -const draggingCol3 = { - columnId: 'col3', - groupId: 'b', - layerId: 'first', - id: 'col3', - humanData: { - label: '', - }, -}; - -const draggingCol4 = { - columnId: 'col4', - groupId: 'c', - layerId: 'first', - id: 'col4', - humanData: { - label: '', - }, - filterOperations: (op: OperationMetadata) => op.isBucketed === false, -}; - -/** - * The datasource exposes four main pieces of code which are tested at - * an integration test level. The main reason for this fairly high level - * of testing is that there is a lot of UI logic that isn't easily - * unit tested, such as the transient invalid state. - * - * - Dimension trigger: Not tested here - * - Dimension editor component: First half of the tests - * - * - getDropProps: Returns drop types that are possible for the current dragging field or other dimension - * - onDrop: Correct application of drop logic - */ -describe('IndexPatternDimensionEditorPanel', () => { - let state: IndexPatternPrivateState; - let setState: jest.Mock; - let defaultProps: IndexPatternDimensionEditorProps; - - function getStateWithMultiFieldColumn() { - return { - ...state, - layers: { - ...state.layers, - first: { - ...state.layers.first, - columns: { - ...state.layers.first.columns, - col1: { - label: 'Top values of dest', - dataType: 'string', - isBucketed: true, - - // Private - operationType: 'terms', - params: { - orderBy: { type: 'alphabetical' }, - orderDirection: 'desc', - size: 10, - }, - sourceField: 'dest', - } as TermsIndexPatternColumn, - }, - }, - }, - }; - } - - beforeEach(() => { - state = { - indexPatternRefs: [], - indexPatterns: expectedIndexPatterns, - currentIndexPatternId: 'foo', - isFirstExistenceFetch: false, - existingFields: { - 'my-fake-index-pattern': { - timestamp: true, - bytes: true, - memory: true, - source: true, - }, - }, - layers: { first: { ...oneColumnLayer } }, - }; - - setState = jest.fn(); - - defaultProps = { - state, - setState, - dateRange: { fromDate: 'now-1d', toDate: 'now' }, - columnId: 'col1', - layerId: 'first', - uniqueLabel: 'stuff', - groupId: 'group1', - filterOperations: () => true, - storage: {} as IStorageWrapper, - uiSettings: {} as IUiSettingsClient, - savedObjectsClient: {} as SavedObjectsClientContract, - http: {} as HttpSetup, - data: { - fieldFormats: { - getType: jest.fn().mockReturnValue({ - id: 'number', - title: 'Number', - }), - getDefaultType: jest.fn().mockReturnValue({ - id: 'bytes', - title: 'Bytes', - }), - } as unknown as DataPublicPluginStart['fieldFormats'], - } as unknown as DataPublicPluginStart, - unifiedSearch: {} as UnifiedSearchPublicPluginStart, - dataViews: {} as DataViewsPublicPluginStart, - core: {} as CoreSetup, - dimensionGroups: [], - isFullscreen: false, - toggleFullscreen: () => {}, - supportStaticValue: false, - layerType: layerTypes.DATA, - }; - - jest.clearAllMocks(); - }); - - const groupId = 'a'; - - describe('getDropProps', () => { - it('returns undefined if no drag is happening', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { name: 'bar', id: 'bar', humanData: { label: 'Label' } }, - }) - ).toBe(undefined); - }); - - it('returns undefined if the dragged item has no field', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - name: 'bar', - id: 'bar', - humanData: { label: 'Label' }, - }, - }) - ).toBe(undefined); - }); - - describe('dragging a field', () => { - it('returns undefined if field is not supported by filterOperations', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: draggingField, - filterOperations: () => false, - }) - ).toBe(undefined); - }); - - it('returns field_replace if the field is supported by filterOperations and the dropTarget is an existing column', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: draggingField, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - }) - ).toEqual({ dropTypes: ['field_replace'], nextLabel: 'Intervals' }); - }); - - it('returns field_add if the field is supported by filterOperations and the dropTarget is an empty column', () => { - expect( - getDropProps({ - ...defaultProps, - columnId: 'newId', - groupId, - dragging: draggingField, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - }) - ).toEqual({ dropTypes: ['field_add'], nextLabel: 'Intervals' }); - }); - - it('returns undefined if the field belongs to another index pattern', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - field: { type: 'number', name: 'bar', aggregatable: true }, - indexPatternId: 'foo2', - id: 'bar', - humanData: { label: 'Label' }, - }, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - }) - ).toBe(undefined); - }); - - it('returns undefined if the dragged field is already in use by this operation', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - field: { - name: 'timestamp', - displayName: 'timestampLabel', - type: 'date', - aggregatable: true, - searchable: true, - exists: true, - }, - indexPatternId: 'foo', - id: 'bar', - humanData: { label: 'Label' }, - }, - }) - ).toBe(undefined); - }); - - it('returns also field_combine if the field is supported by filterOperations and the dropTarget is an existing column that supports multiple fields', () => { - // replace the state with a top values column to enable the multi fields behaviour - state = getStateWithMultiFieldColumn(); - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: draggingField, - filterOperations: (op: OperationMetadata) => op.dataType !== 'date', - }) - ).toEqual({ dropTypes: ['field_replace', 'field_combine'] }); - }); - }); - - describe('dragging a column', () => { - it('returns undefined if the dragged column from different group uses the same field as the dropTarget', () => { - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - label: 'Date histogram of timestamp (1)', - customLabel: true, - dataType: 'date', - isBucketed: true, - - // Private - operationType: 'date_histogram', - params: { - interval: '1d', - }, - sourceField: 'timestamp', - } as DateHistogramIndexPatternColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual(undefined); - }); - - it('returns undefined if the dragged column from different group uses the same fields as the dropTarget', () => { - state = getStateWithMultiFieldColumn(); - const sourceMultiFieldColumn = { - ...state.layers.first.columns.col1, - sourceField: 'bytes', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - secondaryFields: ['dest'], - }, - } as TermsIndexPatternColumn; - // invert the fields - const targetMultiFieldColumn = { - ...state.layers.first.columns.col1, - sourceField: 'dest', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - secondaryFields: ['bytes'], - }, - } as TermsIndexPatternColumn; - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: sourceMultiFieldColumn, - col2: targetMultiFieldColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual(undefined); - }); - - it('returns duplicate and replace if the dragged column from different group uses the same field as the dropTarget, but this last one is multifield, and can be swappable', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - ...state.layers.first.columns.col1, - sourceField: 'bytes', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - secondaryFields: ['dest'], - }, - } as TermsIndexPatternColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ - dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], - }); - }); - - it('returns swap, duplicate and replace if the dragged column from different group uses the same field as the dropTarget, but this last one is multifield', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - ...state.layers.first.columns.col1, - sourceField: 'bytes', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - secondaryFields: ['dest'], - }, - } as TermsIndexPatternColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - // make it swappable - dimensionGroups: [ - { - accessors: [{ columnId: 'col1' }], - filterOperations: jest.fn(() => true), - groupId, - groupLabel: '', - supportsMoreColumns: false, - }, - ], - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ - dropTypes: ['replace_compatible', 'replace_duplicate_compatible', 'swap_compatible'], - }); - }); - - it('returns reorder if drop target and droppedItem columns are from the same group and both are existing', () => { - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - label: 'Sum of bytes', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'sum', - sourceField: 'bytes', - }, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { ...draggingCol1, groupId }, - columnId: 'col2', - filterOperations: (op: OperationMetadata) => op.isBucketed === false, - }) - ).toEqual({ - dropTypes: ['reorder'], - }); - }); - - it('returns duplicate_compatible if drop target and droppedItem columns are from the same group and drop target id is a new column', () => { - expect( - getDropProps({ - ...defaultProps, - columnId: 'newId', - groupId, - dragging: { - ...draggingCol1, - groupId, - }, - }) - ).toEqual({ dropTypes: ['duplicate_compatible'] }); - }); - - it('returns compatible drop types if the dragged column is compatible', () => { - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ dropTypes: ['move_compatible', 'duplicate_compatible'] }); - }); - - it('returns incompatible drop target types if dropping column to existing incompatible column', () => { - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - label: 'Sum of bytes', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'sum', - sourceField: 'bytes', - }, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - filterOperations: (op: OperationMetadata) => op.isBucketed === false, - }) - ).toEqual({ - dropTypes: [ - 'replace_incompatible', - 'replace_duplicate_incompatible', - 'swap_incompatible', - ], - nextLabel: 'Minimum', - }); - }); - - it('does not return swap_incompatible if current dropTarget column cannot be swapped to the group of dragging column', () => { - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - label: 'Count of records', - dataType: 'number', - isBucketed: false, - sourceField: '___records___', - operationType: 'count', - }, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - groupId, - dragging: { - columnId: 'col1', - groupId: 'b', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - filterOperations: (op: OperationMetadata) => op.isBucketed === true, - }, - columnId: 'col2', - filterOperations: (op: OperationMetadata) => op.isBucketed === false, - }) - ).toEqual({ - dropTypes: ['replace_incompatible', 'replace_duplicate_incompatible'], - nextLabel: 'Minimum', - }); - }); - - it('returns combine_compatible drop type if the dragged column is compatible and the target one support multiple fields', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - ...state.layers.first.columns.col1, - sourceField: 'bytes', - }, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ - dropTypes: ['replace_compatible', 'replace_duplicate_compatible', 'combine_compatible'], - }); - }); - - it('returns no combine_compatible drop type if the target column uses rarity ordering', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - ...state.layers.first.columns.col1, - sourceField: 'bytes', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - orderBy: { type: 'rare' }, - }, - } as TermsIndexPatternColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ - dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], - }); - }); - - it('returns no combine drop type if the dragged column is compatible, the target one supports multiple fields but there are too many fields', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - ...state.layers.first.columns.col1, - sourceField: 'source', - params: { - ...(state.layers.first.columns.col1 as TermsIndexPatternColumn).params, - secondaryFields: ['memory', 'bytes', 'geo.src'], // too many fields here - }, - } as TermsIndexPatternColumn, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - dragging: { - ...draggingCol1, - groupId: 'c', - }, - columnId: 'col2', - }) - ).toEqual({ - dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], - }); - }); - - it('returns combine_incompatible drop target types if dropping column to existing incompatible column which supports multiple fields', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: state.layers.first.columns.col1, - - col2: { - label: 'Sum of bytes', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'sum', - sourceField: 'bytes', - }, - }, - }; - - expect( - getDropProps({ - ...defaultProps, - state, - groupId, - // drag the sum over the top values - dragging: { - ...draggingCol2, - groupId: 'c', - filterOperation: undefined, - }, - columnId: 'col1', - filterOperations: (op: OperationMetadata) => op.isBucketed, - }) - ).toEqual({ - dropTypes: [ - 'replace_incompatible', - 'replace_duplicate_incompatible', - 'swap_incompatible', - 'combine_incompatible', - ], - nextLabel: 'Top values', - }); - }); - }); - }); - - describe('onDrop', () => { - describe('dropping a field', () => { - it('updates a column when a field is dropped', () => { - onDrop({ - ...defaultProps, - droppedItem: draggingField, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - dropType: 'field_replace', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: expect.objectContaining({ - columns: expect.objectContaining({ - col1: expect.objectContaining({ - dataType: 'number', - sourceField: 'bytes', - }), - }), - }), - }, - }); - }); - it('selects the specific operation that was valid on drop', () => { - onDrop({ - ...defaultProps, - droppedItem: draggingField, - columnId: 'col2', - filterOperations: (op: OperationMetadata) => op.isBucketed, - dropType: 'field_replace', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: { - ...state.layers.first, - columnOrder: ['col1', 'col2'], - columns: { - ...state.layers.first.columns, - col2: expect.objectContaining({ - dataType: 'number', - sourceField: 'bytes', - }), - }, - }, - }, - }); - }); - it('keeps the operation when dropping a different compatible field', () => { - onDrop({ - ...defaultProps, - droppedItem: { - field: { name: 'memory', type: 'number', aggregatable: true }, - indexPatternId: 'foo', - id: '1', - }, - state: { - ...state, - layers: { - first: { - indexPatternId: 'foo', - columnOrder: ['col1'], - columns: { - col1: { - label: 'Sum of bytes', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'sum', - sourceField: 'bytes', - }, - }, - }, - }, - }, - dropType: 'field_replace', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: expect.objectContaining({ - columns: expect.objectContaining({ - col1: expect.objectContaining({ - operationType: 'sum', - dataType: 'number', - sourceField: 'memory', - }), - }), - }), - }, - }); - }); - it('appends the dropped column when a field is dropped', () => { - onDrop({ - ...defaultProps, - droppedItem: draggingField, - dropType: 'field_replace', - columnId: 'col2', - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: { - ...state.layers.first, - columnOrder: ['col1', 'col2'], - columns: { - ...state.layers.first.columns, - col2: expect.objectContaining({ - dataType: 'number', - sourceField: 'bytes', - }), - }, - }, - }, - }); - }); - it('dimensionGroups are defined - appends the dropped column in the right place when a field is dropped', () => { - const testState = { ...state }; - testState.layers.first = { ...multipleColumnsLayer }; - // config: - // a: - // b: col1, col2, col3 - // c: col4 - // dragging field into newCol in group a - - onDrop({ - ...defaultProps, - droppedItem: draggingField, - columnId: 'newCol', - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - groupId: 'a', - dimensionGroups, - dropType: 'field_add', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], - columns: { - newCol: expect.objectContaining({ - dataType: 'number', - sourceField: 'bytes', - }), - col1: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - incompleteColumns: {}, - }, - }, - }); - }); - - it('appends the new field to the column that supports multiple fields when a field is dropped', () => { - state = getStateWithMultiFieldColumn(); - onDrop({ - ...defaultProps, - state, - droppedItem: draggingField, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - dropType: 'field_combine', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: expect.objectContaining({ - columns: expect.objectContaining({ - col1: expect.objectContaining({ - dataType: 'string', - sourceField: 'dest', - params: expect.objectContaining({ secondaryFields: ['bytes'] }), - }), - }), - }), - }, - }); - }); - }); - - describe('dropping a dimension', () => { - const dragging = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - }; - - it('sets correct order in group for metric and bucket columns when duplicating a column in group', () => { - const testState: IndexPatternPrivateState = { - ...state, - layers: { - first: { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: { - label: 'Date histogram of timestamp', - dataType: 'date', - isBucketed: true, - operationType: 'date_histogram', - params: { - interval: '1d', - }, - sourceField: 'timestamp', - } as DateHistogramIndexPatternColumn, - col2: { - label: 'Top values of bar', - dataType: 'number', - isBucketed: true, - operationType: 'terms', - sourceField: 'bar', - params: { - orderBy: { type: 'alphabetical' }, - orderDirection: 'asc', - size: 5, - }, - } as TermsIndexPatternColumn, - col3: { - operationType: 'average', - sourceField: 'memory', - label: 'average of memory', - dataType: 'number', - isBucketed: false, - }, - }, - }, - }, - }; - - const referenceDragging = { - columnId: 'col3', - groupId: 'a', - layerId: 'first', - id: 'col3', - humanData: { label: 'Label' }, - }; - - onDrop({ - ...defaultProps, - droppedItem: referenceDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'newCol', - }); - // metric is appended - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3', 'newCol'], - columns: { - col1: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - newCol: testState.layers.first.columns.col3, - }, - }, - }, - }); - - const bucketDragging = { - columnId: 'col2', - groupId: 'a', - layerId: 'first', - id: 'col2', - humanData: { label: 'Label' }, - }; - - onDrop({ - ...defaultProps, - droppedItem: bucketDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'newCol', - }); - - // bucket is placed after the last existing bucket - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'newCol', 'col3'], - columns: { - col1: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - newCol: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - }, - }, - }, - }); - }); - - it('when duplicating fullReference column, the referenced columns get duplicated too', () => { - (generateId as jest.Mock).mockReturnValue(`ref1Copy`); - const testState: IndexPatternPrivateState = { - ...state, - layers: { - first: { - indexPatternId: '1', - columnOrder: ['col1', 'ref1'], - columns: { - col1: { - label: 'Test reference', - dataType: 'number', - isBucketed: false, - operationType: 'cumulative_sum', - references: ['ref1'], - }, - ref1: { - label: 'Count of records', - dataType: 'number', - isBucketed: false, - sourceField: '___records___', - operationType: 'count', - }, - }, - }, - }, - }; - const referenceDragging = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - }; - onDrop({ - ...defaultProps, - droppedItem: referenceDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'col1Copy', - }); - - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'ref1', 'ref1Copy', 'col1Copy'], - columns: { - ref1: testState.layers.first.columns.ref1, - col1: testState.layers.first.columns.col1, - ref1Copy: { ...testState.layers.first.columns.ref1 }, - col1Copy: { - ...testState.layers.first.columns.col1, - references: ['ref1Copy'], - }, - }, - }, - }, - }); - }); - - it('when duplicating fullReference column, the multiple referenced columns get duplicated too', () => { - (generateId as jest.Mock).mockReturnValueOnce(`ref1Copy`); - (generateId as jest.Mock).mockReturnValueOnce(`ref2Copy`); - const testState: IndexPatternPrivateState = { - ...state, - layers: { - first: { - indexPatternId: '1', - columnOrder: ['col1', 'ref1'], - columns: { - col1: { - label: 'Test reference', - dataType: 'number', - isBucketed: false, - operationType: 'cumulative_sum', - references: ['ref1', 'ref2'], - }, - ref1: { - label: 'Count of records', - dataType: 'number', - isBucketed: false, - sourceField: '___records___', - operationType: 'count', - }, - ref2: { - label: 'Unique count of bytes', - dataType: 'number', - isBucketed: false, - sourceField: 'bytes', - operationType: 'unique_count', - }, - }, - }, - }, - }; - const metricDragging = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - }; - onDrop({ - ...defaultProps, - droppedItem: metricDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'col1Copy', - }); - - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'ref1', 'ref2', 'ref1Copy', 'col1Copy', 'ref2Copy'], - columns: { - ref1: testState.layers.first.columns.ref1, - ref2: testState.layers.first.columns.ref2, - col1: testState.layers.first.columns.col1, - ref2Copy: { ...testState.layers.first.columns.ref2 }, - ref1Copy: { ...testState.layers.first.columns.ref1 }, - col1Copy: { - ...testState.layers.first.columns.col1, - references: ['ref1Copy', 'ref2Copy'], - }, - }, - }, - }, - }); - }); - - it('when duplicating fullReference column, the referenced columns get duplicated recursively', () => { - (generateId as jest.Mock).mockReturnValueOnce(`ref1Copy`); - (generateId as jest.Mock).mockReturnValueOnce(`innerRef1Copy`); - (generateId as jest.Mock).mockReturnValueOnce(`ref2Copy`); - const testState: IndexPatternPrivateState = { - ...state, - layers: { - first: { - indexPatternId: '1', - columnOrder: ['innerRef1', 'ref2', 'ref1', 'col1'], - columns: { - col1: { - label: 'Test reference', - dataType: 'number', - isBucketed: false, - operationType: 'cumulative_sum', - references: ['ref1', 'ref2'], - }, - ref1: { - label: 'Reference that has a reference', - dataType: 'number', - isBucketed: false, - operationType: 'cumulative_sum', - references: ['innerRef1'], - }, - innerRef1: { - label: 'Count of records', - dataType: 'number', - isBucketed: false, - sourceField: '___records___', - operationType: 'count', - }, - ref2: { - label: 'Unique count of bytes', - dataType: 'number', - isBucketed: false, - sourceField: 'bytes', - operationType: 'unique_count', - }, - }, - }, - }, - }; - const refDragging = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - }; - onDrop({ - ...defaultProps, - droppedItem: refDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'col1Copy', - }); - - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: [ - 'innerRef1', - 'ref2', - 'ref1', - 'col1', - 'innerRef1Copy', - 'ref1Copy', - 'col1Copy', - 'ref2Copy', - ], - columns: { - innerRef1: testState.layers.first.columns.innerRef1, - ref1: testState.layers.first.columns.ref1, - ref2: testState.layers.first.columns.ref2, - col1: testState.layers.first.columns.col1, - - innerRef1Copy: { ...testState.layers.first.columns.innerRef1 }, - ref2Copy: { ...testState.layers.first.columns.ref2 }, - ref1Copy: { - ...testState.layers.first.columns.ref1, - references: ['innerRef1Copy'], - }, - col1Copy: { - ...testState.layers.first.columns.col1, - references: ['ref1Copy', 'ref2Copy'], - }, - }, - }, - }, - }); - }); - - it('when duplicating fullReference column onto exisitng column, the state will not get modified', () => { - (generateId as jest.Mock).mockReturnValue(`ref1Copy`); - const testState: IndexPatternPrivateState = { - ...state, - layers: { - first: { - indexPatternId: '1', - columnOrder: ['col2', 'ref1', 'col1'], - columns: { - col1: { - label: 'Test reference', - dataType: 'number', - isBucketed: false, - operationType: 'cumulative_sum', - references: ['ref1'], - }, - ref1: { - label: 'Count of records', - dataType: 'number', - isBucketed: false, - sourceField: '___records___', - operationType: 'count', - }, - col2: { - label: 'Minimum', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'min', - sourceField: 'bytes', - customLabel: true, - }, - }, - }, - }, - }; - const referenceDragging = { - columnId: 'col1', - groupId: 'a', - layerId: 'first', - id: 'col1', - humanData: { label: 'Label' }, - }; - onDrop({ - ...defaultProps, - droppedItem: referenceDragging, - state: testState, - dropType: 'duplicate_compatible', - columnId: 'col2', - }); - - expect(setState).toHaveBeenCalledWith(testState); - }); - - it('sets correct order in group when reordering a column in group', () => { - const testState = { - ...state, - layers: { - first: { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: { - label: 'Date histogram of timestamp', - dataType: 'date', - isBucketed: true, - } as GenericIndexPatternColumn, - col2: { - label: 'Top values of bar', - dataType: 'number', - isBucketed: true, - } as GenericIndexPatternColumn, - col3: { - label: 'Top values of memory', - dataType: 'number', - isBucketed: true, - } as GenericIndexPatternColumn, - }, - }, - }, - }; - - const defaultReorderDropParams = { - ...defaultProps, - dragging, - droppedItem: draggingCol1, - state: testState, - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - dropType: 'reorder' as DropType, - }; - - const stateWithColumnOrder = (columnOrder: string[]) => { - return { - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder, - columns: { - ...testState.layers.first.columns, - }, - }, - }, - }; - }; - - // first element to last - onDrop({ - ...defaultReorderDropParams, - columnId: 'col3', - }); - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col2', 'col3', 'col1'])); - - // last element to first - onDrop({ - ...defaultReorderDropParams, - columnId: 'col1', - droppedItem: { - columnId: 'col3', - groupId: 'a', - layerId: 'first', - id: 'col3', - }, - }); - expect(setState).toBeCalledTimes(2); - expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col3', 'col1', 'col2'])); - - // middle column to first - onDrop({ - ...defaultReorderDropParams, - columnId: 'col1', - droppedItem: { - columnId: 'col2', - groupId: 'a', - layerId: 'first', - id: 'col2', - }, - }); - expect(setState).toBeCalledTimes(3); - expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col2', 'col1', 'col3'])); - - // middle column to last - onDrop({ - ...defaultReorderDropParams, - columnId: 'col3', - droppedItem: { - columnId: 'col2', - groupId: 'a', - layerId: 'first', - id: 'col2', - }, - }); - expect(setState).toBeCalledTimes(4); - expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col1', 'col3', 'col2'])); - }); - - it('updates the column id when moving an operation to an empty dimension', () => { - onDrop({ - ...defaultProps, - droppedItem: draggingCol1, - columnId: 'col2', - dropType: 'move_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: { - ...state.layers.first, - columnOrder: ['col2'], - columns: { - col2: state.layers.first.columns.col1, - }, - }, - }, - }); - }); - - it('replaces an operation when moving to a populated dimension', () => { - const testState = { ...state }; - testState.layers.first = { - indexPatternId: 'foo', - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: testState.layers.first.columns.col1, - - col2: { - label: 'Top 10 values of src', - dataType: 'string', - isBucketed: true, - - // Private - operationType: 'terms', - params: { - orderBy: { type: 'column', columnId: 'col3' }, - orderDirection: 'desc', - size: 10, - }, - sourceField: 'src', - } as TermsIndexPatternColumn, - col3: { - label: 'Count', - dataType: 'number', - isBucketed: false, - - // Private - operationType: 'count', - sourceField: '___records___', - customLabel: true, - }, - }, - }; - - onDrop({ - ...defaultProps, - droppedItem: draggingCol2, - state: testState, - dropType: 'replace_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col3'], - columns: { - col1: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - }, - }, - }, - }); - }); - - it('when combine compatible columns should append dropped column fields into the target one', () => { - state = getStateWithMultiFieldColumn(); - state.layers.first.columns = { - ...state.layers.first.columns, - col2: { - isBucketed: true, - label: 'Top values of source', - operationType: 'terms', - sourceField: 'bytes', - dataType: 'number', - params: { - orderBy: { - type: 'alphabetical', - }, - orderDirection: 'desc', - size: 10, - }, - } as TermsIndexPatternColumn, - }; - onDrop({ - ...defaultProps, - state, - droppedItem: { - columnId: 'col2', - groupId: 'a', - layerId: 'first', - id: 'col2', - humanData: { label: 'Label' }, - }, - filterOperations: (op: OperationMetadata) => op.isBucketed, - dropType: 'combine_compatible', - columnId: 'col1', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: expect.objectContaining({ - columns: expect.objectContaining({ - col1: expect.objectContaining({ - dataType: 'string', - sourceField: 'dest', - params: expect.objectContaining({ secondaryFields: ['bytes'] }), - }), - }), - }), - }, - }); - }); - - describe('dimension group aware ordering and copying', () => { - let testState: IndexPatternPrivateState; - beforeEach(() => { - testState = { ...state }; - testState.layers.first = { ...multipleColumnsLayer }; - }); - - it('respects groups on moving operations between compatible groups', () => { - // config: - // a: - // b: col1, col2, col3 - // c: col4 - // dragging col2 into newCol in group a - onDrop({ - ...defaultProps, - columnId: 'newCol', - droppedItem: draggingCol2, - state: testState, - groupId: 'a', - dimensionGroups, - dropType: 'move_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['newCol', 'col1', 'col3', 'col4'], - columns: { - newCol: testState.layers.first.columns.col2, - col1: testState.layers.first.columns.col1, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('respects groups on duplicating operations between compatible groups', () => { - // config: - // a: - // b: col1, col2, col3 - // c: col4 - // dragging col2 into newCol in group a - onDrop({ - ...defaultProps, - columnId: 'newCol', - droppedItem: draggingCol2, - state: testState, - groupId: 'a', - dimensionGroups, - dropType: 'duplicate_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], - columns: { - newCol: testState.layers.first.columns.col2, - col1: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('respects groups on moving operations between compatible groups with overwrite', () => { - // config: - // a: col1, - // b: col2, col3 - // c: col4 - // dragging col3 onto col1 in group a - onDrop({ - ...defaultProps, - columnId: 'col1', - droppedItem: draggingCol3, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - dropType: 'move_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col4'], - columns: { - col1: testState.layers.first.columns.col3, - col2: testState.layers.first.columns.col2, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('respects groups on moving operations if some columns are not listed in groups', () => { - // config: - // a: col1, - // b: col2, col3 - // c: col4 - // col5, col6 not in visualization groups - // dragging col3 onto col1 in group a - onDrop({ - ...defaultProps, - columnId: 'col1', - droppedItem: draggingCol3, - state: { - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3', 'col4', 'col5', 'col6'], - columns: { - ...testState.layers.first.columns, - col5: { - dataType: 'number', - operationType: 'count', - label: '', - isBucketed: false, - sourceField: '___records___', - customLabel: true, - }, - col6: { - dataType: 'number', - operationType: 'count', - label: '', - isBucketed: false, - sourceField: '___records___', - customLabel: true, - }, - }, - }, - }, - }, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - dropType: 'move_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col4', 'col5', 'col6'], - columns: { - col1: testState.layers.first.columns.col3, - col2: testState.layers.first.columns.col2, - col4: testState.layers.first.columns.col4, - col5: expect.objectContaining({ - dataType: 'number', - operationType: 'count', - label: '', - isBucketed: false, - sourceField: '___records___', - }), - col6: expect.objectContaining({ - dataType: 'number', - operationType: 'count', - label: '', - isBucketed: false, - sourceField: '___records___', - }), - }, - }, - }, - }); - }); - - it('respects groups on duplicating operations between compatible groups with overwrite', () => { - // config: - // a: col1, - // b: col2, col3 - // c: col4 - // dragging col3 onto col1 in group a - - onDrop({ - ...defaultProps, - columnId: 'col1', - droppedItem: draggingCol3, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - dropType: 'duplicate_compatible', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3', 'col4'], - columns: { - col1: testState.layers.first.columns.col3, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('moves newly created dimension to the bottom of the current group', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col1 into newCol in group b - onDrop({ - ...defaultProps, - columnId: 'newCol', - dropType: 'move_compatible', - droppedItem: draggingCol1, - state: testState, - groupId: 'b', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col2', 'col3', 'newCol', 'col4'], - columns: { - newCol: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('copies column to the bottom of the current group', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // copying col1 within group a - onDrop({ - ...defaultProps, - columnId: 'newCol', - dropType: 'duplicate_compatible', - droppedItem: draggingCol1, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'newCol', 'col2', 'col3', 'col4'], - columns: { - col1: testState.layers.first.columns.col1, - newCol: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - }, - }, - }); - }); - - it('appends the dropped column in the right place respecting custom nestingOrder', () => { - // config: - // a: - // b: col1, col2, col3 - // c: col4 - // dragging field into newCol in group a - - onDrop({ - ...defaultProps, - droppedItem: draggingField, - columnId: 'newCol', - filterOperations: (op: OperationMetadata) => op.dataType === 'number', - groupId: 'a', - dimensionGroups: [ - // a and b are ordered in reverse visually, but nesting order keeps them in place for column order - { ...dimensionGroups[1], nestingOrder: 1 }, - { ...dimensionGroups[0], nestingOrder: 0 }, - { ...dimensionGroups[2] }, - ], - dropType: 'field_add', - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...state, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], - columns: { - newCol: expect.objectContaining({ - dataType: 'number', - sourceField: 'bytes', - }), - col1: testState.layers.first.columns.col1, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - incompleteColumns: {}, - }, - }, - }); - }); - - it('moves incompatible column to the bottom of the target group', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col4 into newCol in group a - - onDrop({ - ...defaultProps, - columnId: 'newCol', - dropType: 'move_incompatible', - droppedItem: draggingCol4, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'newCol', 'col2', 'col3'], - columns: { - col1: testState.layers.first.columns.col1, - newCol: expect.objectContaining({ - sourceField: (testState.layers.first.columns.col4 as MedianIndexPatternColumn) - .sourceField, - }), - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - }, - incompleteColumns: {}, - }, - }, - }); - }); - - it('copies incompatible column to the bottom of the target group', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col4 into newCol in group a - - onDrop({ - ...defaultProps, - columnId: 'newCol', - dropType: 'duplicate_incompatible', - droppedItem: draggingCol4, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'newCol', 'col2', 'col3', 'col4'], - columns: { - col1: testState.layers.first.columns.col1, - newCol: expect.objectContaining({ - sourceField: (testState.layers.first.columns.col4 as MedianIndexPatternColumn) - .sourceField, - }), - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col4, - }, - incompleteColumns: {}, - }, - }, - }); - }); - - it('moves incompatible column with overwrite keeping order of target column', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col4 into col2 in group b - - onDrop({ - ...defaultProps, - columnId: 'col2', - dropType: 'move_incompatible', - droppedItem: draggingCol4, - state: testState, - groupId: 'b', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3'], - columns: { - col1: testState.layers.first.columns.col1, - col2: { - isBucketed: true, - label: 'Top 10 values of bytes', - operationType: 'terms', - sourceField: 'bytes', - dataType: 'number', - params: { - orderBy: { - type: 'alphabetical', - }, - orderDirection: 'desc', - size: 10, - parentFormat: { id: 'terms' }, - }, - }, - col3: testState.layers.first.columns.col3, - }, - incompleteColumns: {}, - }, - }, - }); - }); - - it('when swapping compatibly, columns carry order', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col4 into col1 - - onDrop({ - ...defaultProps, - columnId: 'col1', - dropType: 'swap_compatible', - droppedItem: draggingCol4, - state: testState, - groupId: 'a', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3', 'col4'], - columns: { - col1: testState.layers.first.columns.col4, - col2: testState.layers.first.columns.col2, - col3: testState.layers.first.columns.col3, - col4: testState.layers.first.columns.col1, - }, - }, - }, - }); - }); - - it('when swapping incompatibly, newly created columns take order from the columns they replace', () => { - // config: - // a: col1 - // b: col2, col3 - // c: col4 - // dragging col4 into col2 - - onDrop({ - ...defaultProps, - columnId: 'col2', - dropType: 'swap_incompatible', - droppedItem: draggingCol4, - state: testState, - groupId: 'b', - dimensionGroups: [ - { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, - { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, - { ...dimensionGroups[2] }, - ], - }); - - expect(setState).toBeCalledTimes(1); - expect(setState).toHaveBeenCalledWith({ - ...testState, - layers: { - first: { - ...testState.layers.first, - columnOrder: ['col1', 'col2', 'col3', 'col4'], - columns: { - col1: testState.layers.first.columns.col1, - col2: { - isBucketed: true, - label: 'Top 10 values of bytes', - operationType: 'terms', - sourceField: 'bytes', - dataType: 'number', - params: { - orderBy: { - type: 'alphabetical', - }, - orderDirection: 'desc', - parentFormat: { id: 'terms' }, - size: 10, - }, - }, - col3: testState.layers.first.columns.col3, - col4: { - isBucketed: false, - label: 'Unique count of src', - filter: undefined, - operationType: 'unique_count', - sourceField: 'src', - timeShift: undefined, - dataType: 'number', - params: { - emptyAsNull: true, - }, - scale: 'ratio', - }, - }, - incompleteColumns: {}, - }, - }, - }); - }); - }); - }); - }); -}); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.test.ts new file mode 100644 index 0000000000000..f9afc9a00c98f --- /dev/null +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.test.ts @@ -0,0 +1,767 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { DragDropOperation, OperationMetadata } from '../../../types'; +import { TermsIndexPatternColumn } from '../../operations'; +import { getDropProps } from './get_drop_props'; +import { + mockDataViews, + mockedLayers, + mockedDraggedField, + mockedDndOperations, + mockedColumns, +} from './mocks'; +import { generateId } from '../../../id_generator'; + +const getDefaultProps = () => ({ + state: { + indexPatternRefs: [], + indexPatterns: mockDataViews(), + currentIndexPatternId: 'first', + isFirstExistenceFetch: false, + existingFields: { + first: { + timestamp: true, + bytes: true, + memory: true, + source: true, + }, + }, + layers: { first: mockedLayers.doubleColumnLayer(), second: mockedLayers.emptyLayer() }, + }, + target: mockedDndOperations.notFiltering, + source: mockedDndOperations.bucket, +}); + +describe('IndexPatternDimensionEditorPanel#getDropProps', () => { + describe('not dragging', () => { + it('returns undefined if no drag is happening', () => { + expect(getDropProps({ ...getDefaultProps(), source: undefined })).toBe(undefined); + }); + + it('returns undefined if the dragged item has no field', () => { + expect( + getDropProps({ + ...getDefaultProps(), + source: { name: 'bar', id: 'bar', humanData: { label: 'Label' } }, + }) + ).toBe(undefined); + }); + }); + + describe('dragging a field', () => { + it('returns undefined if field is not supported by filterOperations', () => { + expect( + getDropProps({ + ...getDefaultProps(), + source: mockedDraggedField, + target: mockedDndOperations.staticValue, + }) + ).toBe(undefined); + }); + + it('returns field_replace if the field is supported by filterOperations and the dropTarget is an existing column', () => { + expect( + getDropProps({ + ...getDefaultProps(), + target: mockedDndOperations.numericalOnly, + source: mockedDraggedField, + }) + ).toEqual({ dropTypes: ['field_replace'], nextLabel: 'Intervals' }); + }); + + it('returns field_add if the field is supported by filterOperations and the dropTarget is an empty column', () => { + expect( + getDropProps({ + ...getDefaultProps(), + target: { + ...mockedDndOperations.numericalOnly, + columnId: 'newId', + }, + source: mockedDraggedField, + }) + ).toEqual({ dropTypes: ['field_add'], nextLabel: 'Intervals' }); + }); + + it('returns undefined if the field belongs to another data view', () => { + expect( + getDropProps({ + ...getDefaultProps(), + source: { + ...mockedDraggedField, + indexPatternId: 'first2', + }, + }) + ).toBe(undefined); + }); + + it('returns undefined if the dragged field is already in use by this operation', () => { + expect( + getDropProps({ + ...getDefaultProps(), + source: { + ...mockedDraggedField, + field: { + name: 'timestamp', + displayName: 'timestampLabel', + type: 'date', + aggregatable: true, + searchable: true, + exists: true, + }, + }, + }) + ).toBe(undefined); + }); + + it('returns also field_combine if the field is supported by filterOperations and the dropTarget is an existing column that supports multiple fields', () => { + // replace the state with a top values column to enable the multi fields behaviour + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + source: mockedDraggedField, + target: { + ...props.target, + columnId: 'col2', + filterOperations: (op: OperationMetadata) => op.dataType !== 'date', + }, + }) + ).toEqual({ dropTypes: ['field_replace', 'field_combine'] }); + }); + }); + + describe('dragging a column', () => { + it('allows replacing and replace-duplicating when two columns from compatible groups use the same field', () => { + const props = getDefaultProps(); + props.state.layers.first.columns.col2 = mockedColumns.dateHistogramCopy; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ dropTypes: ['replace_compatible', 'replace_duplicate_compatible'] }); + }); + + it('returns correct dropTypes if the dragged column from different group uses the same fields as the dropTarget', () => { + const props = getDefaultProps(); + const sourceMultiFieldColumn = { + ...props.state.layers.first.columns.col1, + sourceField: 'bytes', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + secondaryFields: ['dest'], + }, + } as TermsIndexPatternColumn; + // invert the fields + const targetMultiFieldColumn = { + ...props.state.layers.first.columns.col1, + sourceField: 'dest', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + secondaryFields: ['bytes'], + }, + } as TermsIndexPatternColumn; + props.state.layers.first.columns = { + col1: sourceMultiFieldColumn, + col2: targetMultiFieldColumn, + }; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ dropTypes: ['replace_compatible', 'replace_duplicate_compatible'] }); + }); + + it('returns duplicate and replace if the dragged column from different group uses the same field as the dropTarget, but this last one is multifield, and can be swappable', () => { + const props = getDefaultProps(); + props.state.layers.first.columns.col2 = { + ...props.state.layers.first.columns.col1, + sourceField: 'bytes', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + secondaryFields: ['dest'], + }, + } as TermsIndexPatternColumn; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], + }); + }); + + it('returns swap, duplicate and replace if the dragged column from different group uses the same field as the dropTarget, but this last one is multifield', () => { + const props = getDefaultProps(); + props.state.layers.first.columns.col2 = { + ...props.state.layers.first.columns.col1, + sourceField: 'bytes', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + secondaryFields: ['dest'], + }, + } as TermsIndexPatternColumn; + + expect( + getDropProps({ + ...props, + ...props, + // make it swappable + target: { + ...props.target, + filterOperations: (op: OperationMetadata) => op.isBucketed, + groupId: 'a', + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + filterOperations: (op: OperationMetadata) => op.isBucketed, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible', 'swap_compatible'], + }); + }); + + it('returns reorder if drop target and source columns are from the same group and both are existing', () => { + const props = getDefaultProps(); + props.state.layers.first.columns.col2 = mockedColumns.sum; + + expect( + getDropProps({ + ...props, + source: { ...mockedDndOperations.metric, groupId: 'a' }, + target: { + ...props.target, + columnId: 'col2', + filterOperations: (op: OperationMetadata) => op.isBucketed === false, + }, + }) + ).toEqual({ + dropTypes: ['reorder'], + }); + }); + + it('returns duplicate_compatible if drop target and source columns are from the same group and drop target id is a new column', () => { + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + target: { + ...props.target, + groupId: 'a', + columnId: 'newId', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'a', + }, + }) + ).toEqual({ dropTypes: ['duplicate_compatible'] }); + }); + + it('returns compatible drop types if the dragged column is compatible', () => { + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + target: { + ...props.target, + groupId: 'a', + columnId: 'col3', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ dropTypes: ['move_compatible', 'duplicate_compatible'] }); + }); + + it('returns incompatible drop target types if dropping column to existing incompatible column', () => { + const props = getDefaultProps(); + props.state.layers.first.columns = { + col1: mockedColumns.dateHistogram, + col2: mockedColumns.sum, + }; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + filterOperations: (op: OperationMetadata) => op.isBucketed === false, + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_incompatible', 'replace_duplicate_incompatible', 'swap_incompatible'], + nextLabel: 'Minimum', + }); + }); + + it('does not return swap_incompatible if current dropTarget column cannot be swapped to the group of dragging column', () => { + const props = getDefaultProps(); + props.state.layers.first.columns = { + col1: mockedColumns.dateHistogram, + col2: mockedColumns.count, + }; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + filterOperations: (op: OperationMetadata) => op.isBucketed === false, + }, + source: { + columnId: 'col1', + groupId: 'b', + layerId: 'first', + id: 'col1', + humanData: { label: 'Label' }, + filterOperations: (op: OperationMetadata) => op.isBucketed === true, + }, + }) + ).toEqual({ + dropTypes: ['replace_incompatible', 'replace_duplicate_incompatible'], + nextLabel: 'Minimum', + }); + }); + + it('returns combine_compatible drop type if the dragged column is compatible and the target one support multiple fields', () => { + const props = getDefaultProps(); + props.state.layers.first.columns = { + col1: mockedColumns.terms, + col2: { + ...mockedColumns.terms, + sourceField: 'bytes', + }, + }; + expect( + getDropProps({ + ...props, + target: { + ...props.target, + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible', 'combine_compatible'], + }); + }); + + it('returns no combine_compatible drop type if the target column uses rarity ordering', () => { + const props = getDefaultProps(); + props.state.layers.first.columns = { + col1: mockedColumns.terms, + col2: { + ...mockedColumns.terms, + sourceField: 'bytes', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + orderBy: { type: 'rare' }, + }, + } as TermsIndexPatternColumn, + }; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + groupId: 'a', + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], + }); + }); + + it('returns no combine drop type if the dragged column is compatible, the target one supports multiple fields but there are too many fields', () => { + const props = getDefaultProps(); + props.state.layers.first.columns.col2 = { + ...props.state.layers.first.columns.col1, + sourceField: 'source', + params: { + ...(props.state.layers.first.columns.col1 as TermsIndexPatternColumn).params, + secondaryFields: ['memory', 'bytes', 'geo.src'], // too many fields here + }, + } as TermsIndexPatternColumn; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + groupId: 'a', + columnId: 'col2', + }, + source: { + ...mockedDndOperations.metric, + groupId: 'c', + }, + }) + ).toEqual({ + dropTypes: ['replace_compatible', 'replace_duplicate_compatible'], + }); + }); + + it('returns combine_incompatible drop target types if dropping column to existing incompatible column which supports multiple fields', () => { + const props = getDefaultProps(); + props.state.layers.first.columns = { + col1: mockedColumns.terms, + col2: mockedColumns.sum, + }; + + expect( + getDropProps({ + ...props, + target: { + ...props.target, + groupId: 'a', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + // drag the sum over the top values + source: { + ...mockedDndOperations.bucket, + groupId: 'c', + filterOperation: undefined, + }, + }) + ).toEqual({ + dropTypes: [ + 'replace_incompatible', + 'replace_duplicate_incompatible', + 'swap_incompatible', + 'combine_incompatible', + ], + nextLabel: 'Top values', + }); + }); + }); + + describe('getDropProps between layers', () => { + it('allows dropping to the same group', () => { + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + source: { + ...mockedDndOperations.metric, + columnId: 'col1', + layerId: 'first', + groupId: 'c', + }, + target: { + ...props.target, + columnId: 'newId', + groupId: 'c', + layerId: 'second', + }, + }) + ).toEqual({ + dropTypes: ['move_compatible', 'duplicate_compatible'], + }); + }); + it('allows dropping to compatible groups', () => { + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + source: { + ...mockedDndOperations.metric, + columnId: 'col1', + layerId: 'first', + groupId: 'a', + }, + target: { + ...props.target, + columnId: 'newId', + groupId: 'c', + layerId: 'second', + }, + }) + ).toEqual({ + dropTypes: ['move_compatible', 'duplicate_compatible'], + }); + }); + it('allows incompatible drop', () => { + const props = getDefaultProps(); + expect( + getDropProps({ + ...props, + source: { + ...mockedDndOperations.metric, + columnId: 'col1', + layerId: 'first', + groupId: 'c', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + target: { + ...props.target, + columnId: 'newId', + groupId: 'c', + layerId: 'second', + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + })?.dropTypes + ).toEqual(['move_incompatible', 'duplicate_incompatible']); + }); + it('allows dropping references', () => { + const props = getDefaultProps(); + const referenceDragging = { + columnId: 'col1', + groupId: 'a', + layerId: 'first', + id: 'col1', + humanData: { label: 'Label' }, + }; + + (generateId as jest.Mock).mockReturnValue(`ref1Copy`); + props.state = { + ...props.state, + layers: { + ...props.state.layers, + first: { + indexPatternId: 'first', + columnOrder: ['col1', 'ref1'], + columns: { + col1: { + label: 'Test reference', + dataType: 'number', + isBucketed: false, + operationType: 'cumulative_sum', + references: ['ref1'], + }, + ref1: { + label: 'Count of records', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + }, + }, + }, + }, + }; + + expect( + getDropProps({ + ...props, + source: referenceDragging, + target: { + ...props.target, + columnId: 'newColumnId', + groupId: 'c', + layerId: 'second', + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + })?.dropTypes + ).toEqual(['move_compatible', 'duplicate_compatible']); + }); + it('doesnt allow dropping for different index patterns', () => { + const props = getDefaultProps(); + props.state.layers.second.indexPatternId = 'different index'; + expect( + getDropProps({ + ...props, + source: { + ...mockedDndOperations.metric, + columnId: 'col1', + layerId: 'first', + groupId: 'c', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + target: { + ...props.target, + columnId: 'newId', + groupId: 'c', + layerId: 'second', + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + })?.dropTypes + ).toEqual(undefined); + }); + + it('does not allow static value to be moved when not allowed', () => { + const props = getDefaultProps(); + props.state.layers = { + first: { + indexPatternId: 'first', + columns: { + col1: mockedColumns.dateHistogram, + colMetric: mockedColumns.count, + }, + columnOrder: ['col1', 'colMetric'], + incompleteColumns: {}, + }, + second: { + indexPatternId: 'first', + columns: { + staticValue: mockedColumns.staticValue, + }, + columnOrder: ['staticValue'], + incompleteColumns: {}, + }, + }; + expect( + getDropProps({ + ...props, + source: { + columnId: 'staticValue', + groupId: 'yReferenceLineLeft', + layerId: 'second', + id: 'staticValue', + humanData: { label: 'Label' }, + }, + target: { + layerId: 'first', + columnId: 'col1', + groupId: 'x', + } as DragDropOperation, + })?.dropTypes + ).toEqual(undefined); + }); + it('allow multiple drop types from terms to terms', () => { + const props = getDefaultProps(); + props.state.layers = { + first: { + indexPatternId: 'first', + columns: { + terms: mockedColumns.terms, + metric: mockedColumns.count, + }, + columnOrder: ['terms', 'metric'], + incompleteColumns: {}, + }, + second: { + indexPatternId: 'first', + columns: { + terms2: mockedColumns.terms2, + metric2: mockedColumns.count, + }, + columnOrder: ['terms2', 'metric2'], + incompleteColumns: {}, + }, + }; + expect( + getDropProps({ + ...props, + source: { + columnId: 'terms', + groupId: 'x', + layerId: 'first', + id: 'terms', + humanData: { label: 'Label' }, + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + target: { + columnId: 'terms2', + groupId: 'x', + layerId: 'second', + filterOperations: (op: OperationMetadata) => op.isBucketed, + } as DragDropOperation, + })?.dropTypes + ).toEqual([ + 'replace_compatible', + 'replace_duplicate_compatible', + 'swap_compatible', + 'combine_compatible', + ]); + }); + it('allow multiple drop types from metric on field to terms', () => { + const props = getDefaultProps(); + props.state.layers = { + first: { + indexPatternId: 'first', + columns: { + sum: mockedColumns.sum, + metric: mockedColumns.count, + }, + columnOrder: ['sum', 'metric'], + incompleteColumns: {}, + }, + second: { + indexPatternId: 'first', + columns: { + terms2: mockedColumns.terms2, + metric2: mockedColumns.count, + }, + columnOrder: ['terms2', 'metric2'], + incompleteColumns: {}, + }, + }; + expect( + getDropProps({ + ...props, + source: { + columnId: 'sum', + groupId: 'x', + layerId: 'first', + id: 'sum', + humanData: { label: 'Label' }, + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + target: { + columnId: 'terms2', + groupId: 'x', + layerId: 'second', + filterOperations: (op: OperationMetadata) => op.isBucketed, + } as DragDropOperation, + })?.dropTypes + ).toEqual([ + 'replace_incompatible', + 'replace_duplicate_incompatible', + 'swap_incompatible', + 'combine_incompatible', + ]); + }); + }); +}); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.ts index 3318b8c30909e..744033a2428fa 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/get_drop_props.ts @@ -5,13 +5,7 @@ * 2.0. */ -import { - DatasourceDimensionDropProps, - isDraggedOperation, - DraggedOperation, - DropType, - VisualizationDimensionGroupConfig, -} from '../../../types'; +import { isOperation, DropType, DragDropOperation } from '../../../types'; import { getCurrentFieldsForOperation, getOperationDisplay, @@ -27,12 +21,18 @@ import { IndexPattern, IndexPatternField, DraggedField, + DataViewDragDropOperation, } from '../../types'; - -type GetDropProps = DatasourceDimensionDropProps & { - dragging?: DragContextState['dragging']; - groupId: string; -}; +import { + getDropPropsForSameGroup, + isOperationFromTheSameGroup, +} from '../../../editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils'; + +interface GetDropPropsArgs { + state: IndexPatternPrivateState; + source?: DragContextState['dragging']; + target: DragDropOperation; +} type DropProps = { dropTypes: DropType[]; nextLabel?: string } | undefined; @@ -41,7 +41,7 @@ const operationLabels = getOperationDisplay(); export function getNewOperation( field: IndexPatternField | undefined | false, filterOperations: (meta: OperationMetadata) => boolean, - targetColumn: GenericIndexPatternColumn, + targetColumn?: GenericIndexPatternColumn, prioritizedOperation?: GenericIndexPatternColumn['operationType'] ) { if (!field) { @@ -61,52 +61,50 @@ export function getNewOperation( return existsPrioritizedOperation ? prioritizedOperation : newOperations[0]; } -export function getField( - column: GenericIndexPatternColumn | undefined, - indexPattern: IndexPattern -) { +export function getField(column: GenericIndexPatternColumn | undefined, dataView: IndexPattern) { if (!column) { return; } - const field = (hasField(column) && indexPattern.getFieldByName(column.sourceField)) || undefined; + const field = (hasField(column) && dataView.getFieldByName(column.sourceField)) || undefined; return field; } -export function getDropProps(props: GetDropProps) { - const { state, columnId, layerId, dragging, groupId, filterOperations } = props; - if (!dragging) { +export function getDropProps(props: GetDropPropsArgs) { + const { state, source, target } = props; + if (!source) { return; } + const targetProps: DataViewDragDropOperation = { + ...target, + column: state.layers[target.layerId].columns[target.columnId], + dataView: state.indexPatterns[state.layers[target.layerId].indexPatternId], + }; - if (isDraggedField(dragging)) { - return getDropPropsForField({ ...props, dragging }); + if (isDraggedField(source)) { + return getDropPropsForField({ ...props, source, target: targetProps }); } - if ( - isDraggedOperation(dragging) && - dragging.layerId === layerId && - columnId !== dragging.columnId - ) { - const sourceColumn = state.layers[dragging.layerId].columns[dragging.columnId]; - const targetColumn = state.layers[layerId].columns[columnId]; - const isSameGroup = groupId === dragging.groupId; - if (isSameGroup) { - return getDropPropsForSameGroup(!targetColumn); - } - const layerIndexPattern = state.indexPatterns[state.layers[layerId].indexPatternId]; - - if (filterOperations(sourceColumn)) { - return getDropPropsForCompatibleGroup( - props.dimensionGroups, - dragging.columnId, - sourceColumn, - targetColumn, - layerIndexPattern - ); - } else if (hasTheSameField(sourceColumn, targetColumn)) { + if (isOperation(source)) { + const sourceProps: DataViewDragDropOperation = { + ...source, + column: state.layers[source.layerId]?.columns[source.columnId], + dataView: state.indexPatterns[state.layers[source.layerId]?.indexPatternId], + }; + if (!sourceProps.column) { return; - } else { - return getDropPropsFromIncompatibleGroup({ ...props, dragging }); + } + if (target.columnId !== source.columnId && targetProps.dataView === sourceProps.dataView) { + if (isOperationFromTheSameGroup(source, target)) { + return getDropPropsForSameGroup(!targetProps.column); + } + + if (targetProps.filterOperations?.(sourceProps?.column)) { + return getDropPropsForCompatibleGroup(sourceProps, targetProps); + } else if (hasTheSameField(sourceProps.column, targetProps.column)) { + return; + } else { + return getDropPropsFromIncompatibleGroup(sourceProps, targetProps); + } } } } @@ -126,14 +124,13 @@ function hasTheSameField( function getDropPropsForField({ state, - columnId, - layerId, - dragging, - filterOperations, -}: GetDropProps & { dragging: DraggedField }): DropProps { - const targetColumn = state.layers[layerId].columns[columnId]; - const isTheSameIndexPattern = state.layers[layerId].indexPatternId === dragging.indexPatternId; - const newOperation = getNewOperation(dragging.field, filterOperations, targetColumn); + source, + target, +}: GetDropPropsArgs & { source: DraggedField }): DropProps { + const targetColumn = state.layers[target.layerId].columns[target.columnId]; + const isTheSameIndexPattern = + state.layers[target.layerId].indexPatternId === source.indexPatternId; + const newOperation = getNewOperation(source.field, target.filterOperations, targetColumn); if (isTheSameIndexPattern && newOperation) { const nextLabel = operationLabels[newOperation].displayName; @@ -141,18 +138,13 @@ function getDropPropsForField({ if (!targetColumn) { return { dropTypes: ['field_add'], nextLabel }; } else if ( - (hasField(targetColumn) && targetColumn.sourceField !== dragging.field.name) || + (hasField(targetColumn) && targetColumn.sourceField !== source.field.name) || !hasField(targetColumn) ) { - const layerIndexPattern = state.indexPatterns[state.layers[layerId].indexPatternId]; + const layerDataView = state.indexPatterns[state.layers[target.layerId].indexPatternId]; return hasField(targetColumn) && - layerIndexPattern && - hasOperationSupportForMultipleFields( - layerIndexPattern, - targetColumn, - undefined, - dragging.field - ) + layerDataView && + hasOperationSupportForMultipleFields(layerDataView, targetColumn, undefined, source.field) ? { dropTypes: ['field_replace', 'field_combine'], } @@ -165,82 +157,68 @@ function getDropPropsForField({ return; } -function getDropPropsForSameGroup(isNew?: boolean): DropProps { - return !isNew ? { dropTypes: ['reorder'] } : { dropTypes: ['duplicate_compatible'] }; -} - function getDropPropsForCompatibleGroup( - dimensionGroups: VisualizationDimensionGroupConfig[], - sourceId: string, - sourceColumn?: GenericIndexPatternColumn, - targetColumn?: GenericIndexPatternColumn, - indexPattern?: IndexPattern + sourceProps: DataViewDragDropOperation, + targetProps: DataViewDragDropOperation ): DropProps { - const hasSameField = sourceColumn && hasTheSameField(sourceColumn, targetColumn); - - const canSwap = - targetColumn && - !hasSameField && - dimensionGroups - .find((group) => group.accessors.some((accessor) => accessor.columnId === sourceId)) - ?.filterOperations(targetColumn); - + if (!targetProps.column) { + return { dropTypes: ['move_compatible', 'duplicate_compatible'] }; + } + const canSwap = sourceProps.filterOperations?.(targetProps.column); const swapType: DropType[] = canSwap ? ['swap_compatible'] : []; - if (!targetColumn) { - return { dropTypes: ['move_compatible', 'duplicate_compatible', ...swapType] }; + const dropTypes: DropType[] = ['replace_compatible', 'replace_duplicate_compatible', ...swapType]; + if (!targetProps.dataView || !hasField(targetProps.column)) { + return { dropTypes }; } - if (!indexPattern || !hasField(targetColumn)) { - return { dropTypes: ['replace_compatible', 'replace_duplicate_compatible', ...swapType] }; - } - // With multi fields operations there are more combination of drops now - const dropTypes: DropType[] = []; - if (!hasSameField) { - dropTypes.push('replace_compatible', 'replace_duplicate_compatible'); - } - if (canSwap) { - dropTypes.push('swap_compatible'); - } - if (hasOperationSupportForMultipleFields(indexPattern, targetColumn, sourceColumn)) { + + if ( + hasOperationSupportForMultipleFields( + targetProps.dataView, + targetProps.column, + sourceProps.column + ) + ) { dropTypes.push('combine_compatible'); } - // return undefined if no drop action is available - if (!dropTypes.length) { - return; - } return { dropTypes, }; } -function getDropPropsFromIncompatibleGroup({ - state, - columnId, - layerId, - dragging, - filterOperations, -}: GetDropProps & { dragging: DraggedOperation }): DropProps { - const targetColumn = state.layers[layerId].columns[columnId]; - const sourceColumn = state.layers[dragging.layerId].columns[dragging.columnId]; - - const layerIndexPattern = state.indexPatterns[state.layers[layerId].indexPatternId]; - if (!layerIndexPattern) { +function getDropPropsFromIncompatibleGroup( + sourceProps: DataViewDragDropOperation, + targetProps: DataViewDragDropOperation +): DropProps { + if (!targetProps.dataView || !sourceProps.column) { return; } - const sourceField = getField(sourceColumn, layerIndexPattern); - const newOperationForSource = getNewOperation(sourceField, filterOperations, targetColumn); + const sourceField = getField(sourceProps.column, sourceProps.dataView); + const newOperationForSource = getNewOperation( + sourceField, + targetProps.filterOperations, + targetProps.column + ); if (newOperationForSource) { - const targetField = getField(targetColumn, layerIndexPattern); - const canSwap = Boolean(getNewOperation(targetField, dragging.filterOperations, sourceColumn)); + const targetField = getField(targetProps.column, targetProps.dataView); + const canSwap = Boolean( + getNewOperation(targetField, sourceProps.filterOperations, sourceProps.column) + ); const dropTypes: DropType[] = []; - if (targetColumn) { + if (targetProps.column) { dropTypes.push('replace_incompatible', 'replace_duplicate_incompatible'); if (canSwap) { dropTypes.push('swap_incompatible'); } - if (hasOperationSupportForMultipleFields(layerIndexPattern, targetColumn, sourceColumn)) { + if ( + hasOperationSupportForMultipleFields( + targetProps.dataView, + targetProps.column, + sourceProps.column + ) + ) { dropTypes.push('combine_incompatible'); } } else { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/mocks.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/mocks.ts new file mode 100644 index 0000000000000..40121cf99f546 --- /dev/null +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/mocks.ts @@ -0,0 +1,292 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { IndexPattern, IndexPatternLayer } from '../../types'; +import { documentField } from '../../document_field'; +import { OperationMetadata } from '../../../types'; +import { + DateHistogramIndexPatternColumn, + GenericIndexPatternColumn, + StaticValueIndexPatternColumn, + TermsIndexPatternColumn, +} from '../../operations'; +import { getFieldByNameFactory } from '../../pure_helpers'; +jest.mock('../../../id_generator'); + +export const mockDataViews = (): Record => { + const fields = [ + { + name: 'timestamp', + displayName: 'timestampLabel', + type: 'date', + aggregatable: true, + searchable: true, + exists: true, + }, + { + name: 'bytes', + displayName: 'bytes', + type: 'number', + aggregatable: true, + searchable: true, + exists: true, + }, + { + name: 'memory', + displayName: 'memory', + type: 'number', + aggregatable: true, + searchable: true, + exists: true, + }, + { + name: 'source', + displayName: 'source', + type: 'string', + aggregatable: true, + searchable: true, + exists: true, + }, + { + name: 'src', + displayName: 'src', + type: 'string', + aggregatable: true, + searchable: true, + exists: true, + }, + { + name: 'dest', + displayName: 'dest', + type: 'string', + aggregatable: true, + searchable: true, + exists: true, + }, + documentField, + ]; + return { + first: { + id: 'first', + title: 'first', + timeFieldName: 'timestamp', + hasRestrictions: false, + fields, + getFieldByName: getFieldByNameFactory(fields), + }, + second: { + id: 'second', + title: 'my-fake-restricted-pattern', + hasRestrictions: true, + timeFieldName: 'timestamp', + fields: [fields[0]], + getFieldByName: getFieldByNameFactory([fields[0]]), + }, + }; +}; + +export const mockedColumns: Record = { + count: { + label: 'Count of records', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + }, + staticValue: { + label: 'Static value: 0.75', + dataType: 'number', + operationType: 'static_value', + isStaticValue: true, + isBucketed: false, + scale: 'ratio', + params: { + value: '0.75', + }, + references: [], + } as StaticValueIndexPatternColumn, + dateHistogram: { + label: 'Date histogram of timestamp', + customLabel: true, + dataType: 'date', + isBucketed: true, + + // Private + operationType: 'date_histogram', + params: { + interval: '1d', + }, + sourceField: 'timestamp', + } as DateHistogramIndexPatternColumn, + dateHistogramCopy: { + label: 'Date histogram of timestamp (1)', + customLabel: true, + dataType: 'date', + isBucketed: true, + + // Private + operationType: 'date_histogram', + params: { + interval: '1d', + }, + sourceField: 'timestamp', + } as DateHistogramIndexPatternColumn, + terms: { + label: 'Top 10 values of src', + dataType: 'string', + isBucketed: true, + // Private + operationType: 'terms', + params: { + orderBy: { type: 'alphabetical' }, + orderDirection: 'desc', + size: 10, + }, + sourceField: 'src', + } as TermsIndexPatternColumn, + terms2: { + label: 'Top 10 values of dest', + dataType: 'string', + isBucketed: true, + + // Private + operationType: 'terms', + params: { + orderBy: { type: 'alphabetical' }, + orderDirection: 'desc', + size: 10, + }, + sourceField: 'dest', + } as TermsIndexPatternColumn, + sum: { + label: 'Sum of bytes', + dataType: 'number', + isBucketed: false, + operationType: 'sum', + sourceField: 'bytes', + } as GenericIndexPatternColumn, + median: { + label: 'Median of bytes', + dataType: 'number', + isBucketed: false, + + // Private + operationType: 'median', + sourceField: 'bytes', + } as GenericIndexPatternColumn, + uniqueCount: { + label: 'Unique count of bytes', + dataType: 'number', + isBucketed: false, + sourceField: 'bytes', + operationType: 'unique_count', + } as GenericIndexPatternColumn, +}; + +export const mockedLayers: Record IndexPatternLayer> = { + singleColumnLayer: (id = 'col1') => ({ + indexPatternId: 'first', + columnOrder: [id], + columns: { + [id]: mockedColumns.dateHistogram, + }, + incompleteColumns: {}, + }), + doubleColumnLayer: (id1 = 'col1', id2 = 'col2') => ({ + indexPatternId: 'first', + columnOrder: [id1, id2], + columns: { + [id1]: mockedColumns.dateHistogram, + [id2]: mockedColumns.terms, + }, + incompleteColumns: {}, + }), + multipleColumnsLayer: (id1 = 'col1', id2 = 'col2', id3 = 'col3', id4 = 'col4') => ({ + indexPatternId: 'first', + columnOrder: [id1, id2, id3, id4], + columns: { + [id1]: mockedColumns.dateHistogram, + [id2]: mockedColumns.terms, + [id3]: mockedColumns.terms2, + [id4]: mockedColumns.median, + }, + }), + emptyLayer: () => ({ + indexPatternId: 'first', + columnOrder: [], + columns: {}, + }), +}; + +export const mockedDraggedField = { + field: { type: 'number', name: 'bytes', aggregatable: true }, + indexPatternId: 'first', + id: 'bar', + humanData: { label: 'Label' }, +}; + +export const mockedDndOperations = { + notFiltering: { + layerId: 'first', + groupId: 'a', + filterOperations: () => true, + columnId: 'col1', + id: 'col1', + humanData: { label: 'Column 1' }, + }, + metric: { + layerId: 'first', + groupId: 'a', + columnId: 'col1', + filterOperations: (op: OperationMetadata) => !op.isBucketed, + id: 'col1', + humanData: { label: 'Column 1' }, + }, + numericalOnly: { + layerId: 'first', + groupId: 'a', + columnId: 'col1', + filterOperations: (op: OperationMetadata) => op.dataType === 'number', + id: 'col1', + humanData: { label: 'Column 1' }, + }, + bucket: { + columnId: 'col2', + groupId: 'b', + layerId: 'first', + id: 'col2', + humanData: { label: 'Column 2' }, + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + staticValue: { + columnId: 'col1', + groupId: 'b', + layerId: 'first', + id: 'col1', + humanData: { label: 'Column 2' }, + filterOperations: (op: OperationMetadata) => !!op.isStaticValue, + }, + bucket2: { + columnId: 'col3', + groupId: 'b', + layerId: 'first', + id: 'col3', + humanData: { + label: '', + }, + }, + metricC: { + columnId: 'col4', + groupId: 'c', + layerId: 'first', + id: 'col4', + humanData: { + label: '', + }, + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, +}; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.test.ts new file mode 100644 index 0000000000000..12acf46c58380 --- /dev/null +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.test.ts @@ -0,0 +1,2259 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { onDrop } from './on_drop_handler'; +import { IndexPatternPrivateState } from '../../types'; +import { OperationMetadata, DropType, DatasourceDimensionDropHandlerProps } from '../../../types'; +import { FormulaIndexPatternColumn, MedianIndexPatternColumn } from '../../operations'; +import { generateId } from '../../../id_generator'; +import { + mockDataViews, + mockedLayers, + mockedDraggedField, + mockedDndOperations, + mockedColumns, +} from './mocks'; + +jest.mock('../../../id_generator'); + +const dimensionGroups = [ + { + accessors: [], + groupId: 'a', + supportsMoreColumns: true, + hideGrouping: true, + groupLabel: '', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + { + accessors: [{ columnId: 'col1' }, { columnId: 'col2' }, { columnId: 'col3' }], + groupId: 'b', + supportsMoreColumns: true, + hideGrouping: true, + groupLabel: '', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + { + accessors: [{ columnId: 'col4' }], + groupId: 'c', + supportsMoreColumns: true, + hideGrouping: true, + groupLabel: '', + filterOperations: (op: OperationMetadata) => op.isBucketed === false, + }, +]; + +function getStateWithMultiFieldColumn(state: IndexPatternPrivateState) { + return { + ...state, + layers: { + ...state.layers, + first: { + ...state.layers.first, + columns: { + col1: mockedColumns.terms2, + }, + }, + }, + }; +} + +describe('IndexPatternDimensionEditorPanel: onDrop', () => { + let state: IndexPatternPrivateState; + let setState: jest.Mock; + let defaultProps: DatasourceDimensionDropHandlerProps; + + beforeEach(() => { + state = { + indexPatternRefs: [], + indexPatterns: mockDataViews(), + currentIndexPatternId: 'first', + isFirstExistenceFetch: false, + existingFields: { + first: { + timestamp: true, + bytes: true, + memory: true, + source: true, + }, + }, + layers: { + first: mockedLayers.singleColumnLayer(), + second: mockedLayers.emptyLayer(), + }, + }; + + setState = jest.fn(); + + defaultProps = { + dropType: 'reorder', + source: { name: 'bar', id: 'bar', humanData: { label: 'Label' } }, + target: mockedDndOperations.notFiltering, + state, + setState, + dimensionGroups: [], + }; + + jest.clearAllMocks(); + }); + + describe('dropping a field', () => { + it('updates a column when a field is dropped', () => { + onDrop({ + ...defaultProps, + source: mockedDraggedField, + dropType: 'field_replace', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: expect.objectContaining({ + columns: expect.objectContaining({ + col1: expect.objectContaining({ + dataType: 'number', + sourceField: mockedDraggedField.field.name, + }), + }), + }), + }, + }); + }); + it('selects the specific operation that was valid on drop', () => { + onDrop({ + ...defaultProps, + source: mockedDraggedField, + dropType: 'field_replace', + target: { + ...defaultProps.target, + filterOperations: (op: OperationMetadata) => op.isBucketed, + columnId: 'col2', + }, + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: { + ...state.layers.first, + columnOrder: ['col1', 'col2'], + columns: { + ...state.layers.first.columns, + col2: expect.objectContaining({ + dataType: 'number', + sourceField: mockedDraggedField.field.name, + }), + }, + }, + }, + }); + }); + it('keeps the operation when dropping a different compatible field', () => { + onDrop({ + ...defaultProps, + source: { + humanData: { label: 'Label1' }, + field: { name: 'memory', type: 'number', aggregatable: true }, + indexPatternId: 'first', + id: '1', + }, + state: { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: 'first', + columnOrder: ['col1'], + columns: { + col1: mockedColumns.sum, + }, + }, + }, + }, + dropType: 'field_replace', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: expect.objectContaining({ + columns: expect.objectContaining({ + col1: expect.objectContaining({ + operationType: 'sum', + dataType: 'number', + sourceField: 'memory', + }), + }), + }), + }, + }); + }); + it('appends the dropped column when a field is dropped', () => { + onDrop({ + ...defaultProps, + source: mockedDraggedField, + dropType: 'field_replace', + target: { + ...defaultProps.target, + columnId: 'col2', + filterOperations: (op: OperationMetadata) => op.dataType === 'number', + }, + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: { + ...state.layers.first, + columnOrder: ['col1', 'col2'], + columns: { + ...state.layers.first.columns, + col2: expect.objectContaining({ + dataType: 'number', + sourceField: mockedDraggedField.field.name, + }), + }, + }, + }, + }); + }); + it('dimensionGroups are defined - appends the dropped column in the right place when a field is dropped', () => { + const testState = { ...state }; + testState.layers.first = { ...mockedLayers.multipleColumnsLayer() }; + // config: + // a: + // b: col1, col2, col3 + // c: col4 + // dragging field into newCol in group a + + onDrop({ + ...defaultProps, + source: mockedDraggedField, + dimensionGroups, + dropType: 'field_add', + target: { + ...defaultProps.target, + filterOperations: (op: OperationMetadata) => op.dataType === 'number', + groupId: 'a', + columnId: 'newCol', + }, + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], + columns: { + newCol: expect.objectContaining({ + dataType: 'number', + sourceField: mockedDraggedField.field.name, + }), + col1: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + incompleteColumns: {}, + }, + }, + }); + }); + + it('appends the new field to the column that supports multiple fields when a field is dropped', () => { + state = getStateWithMultiFieldColumn(state); + onDrop({ + ...defaultProps, + state, + source: mockedDraggedField, + dropType: 'field_combine', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: expect.objectContaining({ + columns: expect.objectContaining({ + col1: expect.objectContaining({ + dataType: 'string', + sourceField: 'dest', + params: expect.objectContaining({ + secondaryFields: [mockedDraggedField.field.name], + }), + }), + }), + }), + }, + }); + }); + }); + + describe('dropping a dimension', () => { + it('sets correct order in group for metric and bucket columns when duplicating a column in group', () => { + const testState: IndexPatternPrivateState = { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: 'first', + columnOrder: ['col1', 'col2', 'col3'], + columns: { + col1: mockedColumns.dateHistogram, + col2: mockedColumns.terms, + col3: mockedColumns.sum, + }, + }, + }, + }; + + const referenceDragging = { + columnId: 'col3', + groupId: 'a', + layerId: 'first', + id: 'col3', + humanData: { label: 'Label' }, + }; + + onDrop({ + ...defaultProps, + source: referenceDragging, + state: testState, + dropType: 'duplicate_compatible', + target: { + ...defaultProps.target, + columnId: 'newCol', + }, + }); + // metric is appended + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3', 'newCol'], + columns: { + col1: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + newCol: testState.layers.first.columns.col3, + }, + }, + }, + }); + + const bucketDragging = { + columnId: 'col2', + groupId: 'a', + layerId: 'first', + id: 'col2', + humanData: { label: 'Label' }, + }; + + onDrop({ + ...defaultProps, + state: testState, + dropType: 'duplicate_compatible', + source: bucketDragging, + target: { + ...defaultProps.target, + columnId: 'newCol', + }, + }); + + // bucket is placed after the last existing bucket + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'newCol', 'col3'], + columns: { + col1: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + newCol: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + }, + }, + }, + }); + }); + + it('when duplicating fullReference column, the referenced columns get duplicated too', () => { + (generateId as jest.Mock).mockReturnValue(`ref1Copy`); + const testState: IndexPatternPrivateState = { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: '1', + columnOrder: ['col1', 'ref1'], + columns: { + col1: { + label: 'Test reference', + dataType: 'number', + isBucketed: false, + operationType: 'cumulative_sum', + references: ['ref1'], + }, + ref1: mockedColumns.count, + }, + }, + }, + }; + const referenceDragging = { + columnId: 'col1', + groupId: 'a', + layerId: 'first', + id: 'col1', + humanData: { label: 'Label' }, + }; + onDrop({ + ...defaultProps, + source: referenceDragging, + state: testState, + dropType: 'duplicate_compatible', + target: { + ...defaultProps.target, + columnId: 'col1Copy', + }, + }); + + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'ref1', 'ref1Copy', 'col1Copy'], + columns: { + ref1: testState.layers.first.columns.ref1, + col1: testState.layers.first.columns.col1, + ref1Copy: { ...testState.layers.first.columns.ref1 }, + col1Copy: { + ...testState.layers.first.columns.col1, + references: ['ref1Copy'], + }, + }, + }, + }, + }); + }); + + it('when duplicating fullReference column, the multiple referenced columns get duplicated too', () => { + (generateId as jest.Mock).mockReturnValueOnce(`ref1Copy`); + (generateId as jest.Mock).mockReturnValueOnce(`ref2Copy`); + const testState: IndexPatternPrivateState = { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: '1', + columnOrder: ['col1', 'ref1'], + columns: { + col1: { + label: 'Test reference', + dataType: 'number', + isBucketed: false, + operationType: 'cumulative_sum', + references: ['ref1', 'ref2'], + }, + ref1: mockedColumns.count, + ref2: mockedColumns.uniqueCount, + }, + }, + }, + }; + const metricDragging = { + columnId: 'col1', + groupId: 'a', + layerId: 'first', + id: 'col1', + humanData: { label: 'Label' }, + }; + onDrop({ + ...defaultProps, + source: metricDragging, + state: testState, + dropType: 'duplicate_compatible', + target: { + ...defaultProps.target, + columnId: 'col1Copy', + }, + }); + + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'ref1', 'ref2', 'ref1Copy', 'ref2Copy', 'col1Copy'], + columns: { + ref1: testState.layers.first.columns.ref1, + ref2: testState.layers.first.columns.ref2, + col1: testState.layers.first.columns.col1, + ref2Copy: { ...testState.layers.first.columns.ref2 }, + ref1Copy: { ...testState.layers.first.columns.ref1 }, + col1Copy: { + ...testState.layers.first.columns.col1, + references: ['ref1Copy', 'ref2Copy'], + }, + }, + }, + }, + }); + }); + + it('when duplicating fullReference column, the referenced columns get duplicated', () => { + (generateId as jest.Mock).mockReturnValueOnce(`ref1Copy`); + (generateId as jest.Mock).mockReturnValueOnce(`ref2Copy`); + const testState: IndexPatternPrivateState = { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: '1', + columnOrder: ['ref2', 'ref1', 'col1'], + columns: { + col1: { + label: 'Test reference', + dataType: 'number', + isBucketed: false, + operationType: 'cumulative_sum', + references: ['ref1', 'ref2'], + }, + ref1: mockedColumns.count, + ref2: { + label: 'Unique count of bytes', + dataType: 'number', + isBucketed: false, + sourceField: 'bytes', + operationType: 'unique_count', + }, + }, + }, + }, + }; + const refDragging = { + columnId: 'col1', + groupId: 'a', + layerId: 'first', + id: 'col1', + humanData: { label: 'Label' }, + }; + onDrop({ + ...defaultProps, + source: refDragging, + state: testState, + dropType: 'duplicate_compatible', + target: { + ...defaultProps.target, + columnId: 'col1Copy', + }, + }); + + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['ref2', 'ref1', 'col1', 'ref1Copy', 'ref2Copy', 'col1Copy'], + columns: { + ref1: testState.layers.first.columns.ref1, + ref2: testState.layers.first.columns.ref2, + col1: testState.layers.first.columns.col1, + ref2Copy: { ...testState.layers.first.columns.ref2 }, + ref1Copy: { + ...testState.layers.first.columns.ref1, + }, + col1Copy: { + ...testState.layers.first.columns.col1, + references: ['ref1Copy', 'ref2Copy'], + }, + }, + }, + }, + }); + }); + + it('sets correct order in group when reordering a column in group', () => { + const testState = { + ...state, + layers: { + ...state.layers, + first: { + indexPatternId: 'first', + columnOrder: ['col1', 'col2', 'col3'], + columns: { + col1: mockedColumns.dateHistogram, + col2: mockedColumns.terms, + col3: mockedColumns.terms2, + }, + }, + }, + }; + + const defaultReorderDropParams = { + ...defaultProps, + target: { + ...defaultProps.target, + filterOperations: (op: OperationMetadata) => op.dataType === 'number', + }, + source: mockedDndOperations.metric, + state: testState, + dropType: 'reorder' as DropType, + }; + + const stateWithColumnOrder = (columnOrder: string[]) => { + return { + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder, + columns: { + ...testState.layers.first.columns, + }, + }, + }, + }; + }; + + // first element to last + onDrop({ + ...defaultReorderDropParams, + target: { + ...defaultReorderDropParams.target, + columnId: 'col3', + }, + }); + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col2', 'col3', 'col1'])); + + // last element to first + onDrop({ + ...defaultReorderDropParams, + target: { + ...defaultReorderDropParams.target, + columnId: 'col1', + }, + source: { + humanData: { label: 'Label1' }, + columnId: 'col3', + groupId: 'a', + layerId: 'first', + id: 'col3', + }, + }); + expect(setState).toBeCalledTimes(2); + expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col3', 'col1', 'col2'])); + + // middle column to first + onDrop({ + ...defaultReorderDropParams, + target: { + ...defaultReorderDropParams.target, + columnId: 'col1', + }, + source: { + humanData: { label: 'Label1' }, + columnId: 'col2', + groupId: 'a', + layerId: 'first', + id: 'col2', + }, + }); + expect(setState).toBeCalledTimes(3); + expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col2', 'col1', 'col3'])); + + // middle column to last + onDrop({ + ...defaultReorderDropParams, + target: { + ...defaultReorderDropParams.target, + columnId: 'col3', + }, + source: { + humanData: { label: 'Label1' }, + columnId: 'col2', + groupId: 'a', + layerId: 'first', + id: 'col2', + }, + }); + expect(setState).toBeCalledTimes(4); + expect(setState).toHaveBeenCalledWith(stateWithColumnOrder(['col1', 'col3', 'col2'])); + }); + + it('updates the column id when moving an operation to an empty dimension', () => { + onDrop({ + ...defaultProps, + source: mockedDndOperations.metric, + target: { + ...defaultProps.target, + columnId: 'col2', + }, + dropType: 'move_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: { + ...state.layers.first, + columnOrder: ['col2'], + columns: { + col2: state.layers.first.columns.col1, + }, + }, + }, + }); + }); + + it('replaces an operation when moving to a populated dimension', () => { + const testState = { ...state }; + testState.layers.first = { + indexPatternId: 'first', + columnOrder: ['col1', 'col2', 'col3'], + columns: { + col1: testState.layers.first.columns.col1, + col2: mockedColumns.terms, + col3: mockedColumns.count, + }, + }; + + onDrop({ + ...defaultProps, + source: mockedDndOperations.bucket, + state: testState, + dropType: 'replace_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + incompleteColumns: {}, + columnOrder: ['col1', 'col3'], + columns: { + col1: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + }, + }, + }, + }); + }); + + it('when combine compatible columns should append dropped column fields into the target one', () => { + state = getStateWithMultiFieldColumn(state); + state.layers.first.columns = { + ...state.layers.first.columns, + col2: mockedColumns.terms, + }; + onDrop({ + ...defaultProps, + state, + source: { + columnId: 'col2', + groupId: 'a', + layerId: 'first', + id: 'col2', + humanData: { label: 'Label' }, + }, + dropType: 'combine_compatible', + target: { + ...defaultProps.target, + columnId: 'col1', + groupId: 'a', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: expect.objectContaining({ + columns: expect.objectContaining({ + col1: expect.objectContaining({ + dataType: 'string', + sourceField: 'dest', + params: expect.objectContaining({ secondaryFields: ['src'] }), + }), + }), + }), + }, + }); + }); + + describe('dimension group aware ordering and copying', () => { + let testState: IndexPatternPrivateState; + beforeEach(() => { + testState = { ...state }; + testState.layers.first = { ...mockedLayers.multipleColumnsLayer() }; + }); + + it('respects groups on moving operations between compatible groups', () => { + // config: + // a: + // b: col1, col2, col3 + // c: col4 + // dragging col2 into newCol in group a + onDrop({ + ...defaultProps, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + }, + source: mockedDndOperations.bucket, + state: testState, + dimensionGroups, + dropType: 'move_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + incompleteColumns: {}, + columnOrder: ['newCol', 'col1', 'col3', 'col4'], + columns: { + newCol: testState.layers.first.columns.col2, + col1: testState.layers.first.columns.col1, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('respects groups on duplicating operations between compatible groups', () => { + // config: + // a: + // b: col1, col2, col3 + // c: col4 + // dragging col2 into newCol in group a + onDrop({ + ...defaultProps, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + }, + source: mockedDndOperations.bucket, + state: testState, + dimensionGroups, + dropType: 'duplicate_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], + columns: { + newCol: testState.layers.first.columns.col2, + col1: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('respects groups on moving operations between compatible groups with overwrite', () => { + // config: + // a: col1, + // b: col2, col3 + // c: col4 + // dragging col3 onto col1 in group a + onDrop({ + ...defaultProps, + target: { + ...defaultProps.target, + columnId: 'col1', + groupId: 'a', + }, + source: mockedDndOperations.bucket2, + state: testState, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + dropType: 'move_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + incompleteColumns: {}, + columnOrder: ['col1', 'col2', 'col4'], + columns: { + col1: testState.layers.first.columns.col3, + col2: testState.layers.first.columns.col2, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('respects groups on moving operations if some columns are not listed in groups', () => { + // config: + // a: col1, + // b: col2, col3 + // c: col4 + // col5, col6 not in visualization groups + // dragging col3 onto col1 in group a + onDrop({ + ...defaultProps, + source: mockedDndOperations.bucket2, + target: { + ...defaultProps.target, + columnId: 'col1', + groupId: 'a', + }, + state: { + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3', 'col4', 'col5', 'col6'], + columns: { + ...testState.layers.first.columns, + col5: { + dataType: 'number', + operationType: 'count', + label: '', + isBucketed: false, + sourceField: '___records___', + customLabel: true, + }, + col6: { + dataType: 'number', + operationType: 'count', + label: '', + isBucketed: false, + sourceField: '___records___', + customLabel: true, + }, + }, + }, + }, + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + dropType: 'move_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + incompleteColumns: {}, + columnOrder: ['col1', 'col2', 'col4', 'col5', 'col6'], + columns: { + col1: testState.layers.first.columns.col3, + col2: testState.layers.first.columns.col2, + col4: testState.layers.first.columns.col4, + col5: expect.objectContaining({ + dataType: 'number', + operationType: 'count', + label: '', + isBucketed: false, + sourceField: '___records___', + }), + col6: expect.objectContaining({ + dataType: 'number', + operationType: 'count', + label: '', + isBucketed: false, + sourceField: '___records___', + }), + }, + }, + }, + }); + }); + + it('respects groups on duplicating operations between compatible groups with overwrite', () => { + // config: + // a: col1, + // b: col2, col3 + // c: col4 + // dragging col3 onto col1 in group a + + onDrop({ + ...defaultProps, + source: mockedDndOperations.bucket2, + state: testState, + target: { + ...defaultProps.target, + columnId: 'col1', + groupId: 'a', + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + dropType: 'duplicate_compatible', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3', 'col4'], + columns: { + col1: testState.layers.first.columns.col3, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('moves newly created dimension to the bottom of the current group', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col1 into newCol in group b + onDrop({ + ...defaultProps, + dropType: 'move_compatible', + source: mockedDndOperations.metric, + state: testState, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'b', + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + incompleteColumns: {}, + columnOrder: ['col2', 'col3', 'newCol', 'col4'], + columns: { + newCol: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('copies column to the bottom of the current group', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // copying col1 within group a + onDrop({ + ...defaultProps, + dropType: 'duplicate_compatible', + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + }, + source: mockedDndOperations.metric, + state: testState, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'newCol', 'col2', 'col3', 'col4'], + columns: { + col1: testState.layers.first.columns.col1, + newCol: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + }, + }, + }); + }); + + it('appends the dropped column in the right place respecting custom nestingOrder', () => { + // config: + // a: + // b: col1, col2, col3 + // c: col4 + // dragging field into newCol in group a + + onDrop({ + ...defaultProps, + source: mockedDraggedField, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + filterOperations: (op: OperationMetadata) => op.dataType === 'number', + }, + dimensionGroups: [ + // a and b are ordered in reverse visually, but nesting order keeps them in place for column order + { ...dimensionGroups[1], nestingOrder: 1 }, + { ...dimensionGroups[0], nestingOrder: 0 }, + { ...dimensionGroups[2] }, + ], + dropType: 'field_add', + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...state, + layers: { + ...state.layers, + first: { + ...testState.layers.first, + columnOrder: ['newCol', 'col1', 'col2', 'col3', 'col4'], + columns: { + newCol: expect.objectContaining({ + dataType: 'number', + sourceField: mockedDraggedField.field.name, + }), + col1: testState.layers.first.columns.col1, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + incompleteColumns: {}, + }, + }, + }); + }); + + it('moves incompatible column to the bottom of the target group', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col4 into newCol in group a + + onDrop({ + ...defaultProps, + dropType: 'move_incompatible', + source: mockedDndOperations.metricC, + state: testState, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'newCol', 'col2', 'col3'], + columns: { + col1: testState.layers.first.columns.col1, + newCol: expect.objectContaining({ + sourceField: (testState.layers.first.columns.col4 as MedianIndexPatternColumn) + .sourceField, + }), + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + }, + incompleteColumns: {}, + }, + }, + }); + }); + + it('copies incompatible column to the bottom of the target group', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col4 into newCol in group a + + onDrop({ + ...defaultProps, + dropType: 'duplicate_incompatible', + source: mockedDndOperations.metricC, + state: testState, + target: { + ...defaultProps.target, + columnId: 'newCol', + groupId: 'a', + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'newCol', 'col2', 'col3', 'col4'], + columns: { + col1: testState.layers.first.columns.col1, + newCol: expect.objectContaining({ + sourceField: (testState.layers.first.columns.col4 as MedianIndexPatternColumn) + .sourceField, + }), + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col4, + }, + incompleteColumns: {}, + }, + }, + }); + }); + + it('moves incompatible column with overwrite keeping order of target column', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col4 into col2 in group b + + onDrop({ + ...defaultProps, + dropType: 'move_incompatible', + source: mockedDndOperations.metricC, + state: testState, + target: { + ...defaultProps.target, + columnId: 'col2', + groupId: 'b', + }, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3'], + columns: { + col1: testState.layers.first.columns.col1, + col2: { + isBucketed: true, + label: 'Top 10 values of bytes', + operationType: 'terms', + sourceField: 'bytes', + dataType: 'number', + params: { + orderBy: { + type: 'alphabetical', + }, + orderDirection: 'desc', + size: 10, + parentFormat: { id: 'terms' }, + }, + }, + col3: testState.layers.first.columns.col3, + }, + incompleteColumns: {}, + }, + }, + }); + }); + + it('when swapping compatibly, columns carry order', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col4 into col1 + + onDrop({ + ...defaultProps, + target: { + ...defaultProps.target, + columnId: 'col1', + groupId: 'a', + }, + source: mockedDndOperations.metricC, + dropType: 'swap_compatible', + state: testState, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3', 'col4'], + columns: { + col1: testState.layers.first.columns.col4, + col2: testState.layers.first.columns.col2, + col3: testState.layers.first.columns.col3, + col4: testState.layers.first.columns.col1, + }, + }, + }, + }); + }); + + it('when swapping incompatibly, newly created columns take order from the columns they replace', () => { + // config: + // a: col1 + // b: col2, col3 + // c: col4 + // dragging col4 into col2 + + onDrop({ + ...defaultProps, + target: { + ...defaultProps.target, + columnId: 'col2', + groupId: 'b', + }, + dropType: 'swap_incompatible', + source: mockedDndOperations.metricC, + state: testState, + dimensionGroups: [ + { ...dimensionGroups[0], accessors: [{ columnId: 'col1' }] }, + { ...dimensionGroups[1], accessors: [{ columnId: 'col2' }, { columnId: 'col3' }] }, + { ...dimensionGroups[2] }, + ], + }); + + expect(setState).toBeCalledTimes(1); + expect(setState).toHaveBeenCalledWith({ + ...testState, + layers: { + ...testState.layers, + first: { + ...testState.layers.first, + columnOrder: ['col1', 'col2', 'col3', 'col4'], + columns: { + col1: testState.layers.first.columns.col1, + col2: { + isBucketed: true, + label: 'Top 10 values of bytes', + operationType: 'terms', + sourceField: 'bytes', + dataType: 'number', + params: { + orderBy: { + type: 'alphabetical', + }, + orderDirection: 'desc', + parentFormat: { id: 'terms' }, + size: 10, + }, + }, + col3: testState.layers.first.columns.col3, + col4: { + isBucketed: false, + label: 'Unique count of src', + filter: undefined, + operationType: 'unique_count', + sourceField: 'src', + timeShift: undefined, + dataType: 'number', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + }, + }, + incompleteColumns: {}, + }, + }, + }); + }); + }); + + describe('onDrop between layers', () => { + const defaultDimensionGroups = [ + { + groupId: 'x', + groupLabel: 'Horizontal axis', + accessors: [], + supportsMoreColumns: true, + dataTestSubj: 'lnsXY_xDimensionPanel', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + { + groupId: 'y', + groupLabel: 'Vertical axis', + accessors: [], + supportsMoreColumns: true, + required: true, + dataTestSubj: 'lnsXY_yDimensionPanel', + enableDimensionEditor: true, + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + { + groupId: 'breakdown', + groupLabel: 'Break down by', + accessors: [], + supportsMoreColumns: true, + dataTestSubj: 'lnsXY_splitDimensionPanel', + required: false, + enableDimensionEditor: true, + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + ]; + describe('simple operations', () => { + let props: DatasourceDimensionDropHandlerProps; + beforeEach(() => { + setState = jest.fn(); + + props = { + state: { + indexPatternRefs: [], + indexPatterns: mockDataViews(), + currentIndexPatternId: 'first', + isFirstExistenceFetch: false, + existingFields: { + first: { + timestamp: true, + bytes: true, + memory: true, + source: true, + }, + }, + layers: { + first: mockedLayers.singleColumnLayer(), + second: mockedLayers.multipleColumnsLayer('col2', 'col3', 'col4', 'col5'), + }, + }, + setState: jest.fn(), + source: { + id: 'col1', + humanData: { label: '2' }, + columnId: 'col1', + groupId: 'x', + layerId: 'first', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + target: { + filterOperations: (op: OperationMetadata) => op.isBucketed, + columnId: 'newCol', + groupId: 'x', + layerId: 'second', + }, + dimensionGroups: defaultDimensionGroups, + dropType: 'move_compatible', + }; + jest.clearAllMocks(); + }); + it('doesnt allow dropping for different data views', () => { + props.state.layers.second.indexPatternId = 'second'; + expect(onDrop(props)).toEqual(false); + expect(props.setState).not.toHaveBeenCalled(); + }); + it('move_compatible; allows dropping to the compatible group in different layer to empty column', () => { + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['col2', 'col3', 'col4', 'newCol', 'col5'], + columns: { + ...props.state.layers.second.columns, + newCol: mockedColumns.dateHistogram, + }, + indexPatternId: 'first', + }, + }, + }); + }); + it('duplicate_compatible: allows dropping to the compatible group in different layer to empty column', () => { + expect(onDrop({ ...props, dropType: 'duplicate_compatible' })).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + second: { + columnOrder: ['col2', 'col3', 'col4', 'newCol', 'col5'], + columns: { + ...props.state.layers.second.columns, + newCol: mockedColumns.dateHistogram, + }, + indexPatternId: 'first', + }, + }, + }); + }); + it('swap_compatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + + target: { + ...props.target, + columnId: 'col4', + groupId: 'breakdown', + layerId: 'second', + }, + dropType: 'swap_compatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...props.state.layers.first, + columns: { + col1: props.state.layers.second.columns.col4, + }, + }, + second: { + ...props.state.layers.second, + columns: { + ...props.state.layers.second.columns, + col4: props.state.layers.first.columns.col1, + }, + }, + }, + }); + }); + it('replace_compatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'col4', + groupId: 'breakdown', + layerId: 'second', + }, + dropType: 'replace_compatible', + }; + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5'], + columns: { + ...props.state.layers.second.columns, + col4: mockedColumns.dateHistogram, + }, + indexPatternId: 'first', + }, + }, + }); + }); + it('replace_duplicate_compatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'col4', + groupId: 'breakdown', + layerId: 'second', + }, + dropType: 'replace_duplicate_compatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5'], + columns: { + ...props.state.layers.second.columns, + col4: mockedColumns.dateHistogram, + }, + indexPatternId: 'first', + }, + }, + }); + }); + it('replace_duplicate_incompatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'col5', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + dropType: 'replace_duplicate_incompatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5'], + columns: { + ...props.state.layers.second.columns, + col5: { + dataType: 'date', + isBucketed: false, + label: 'Minimum of timestampLabel', + operationType: 'min', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + sourceField: 'timestamp', + }, + }, + incompleteColumns: {}, + indexPatternId: 'first', + }, + }, + }); + }); + it('replace_incompatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'col5', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + dropType: 'replace_incompatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5'], + columns: { + ...props.state.layers.second.columns, + col5: { + dataType: 'date', + isBucketed: false, + label: 'Minimum of timestampLabel', + operationType: 'min', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + sourceField: 'timestamp', + }, + }, + incompleteColumns: {}, + indexPatternId: 'first', + }, + }, + }); + }); + it('move_incompatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'newCol', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + dropType: 'move_incompatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5', 'newCol'], + columns: { + ...props.state.layers.second.columns, + newCol: { + dataType: 'date', + isBucketed: false, + label: 'Minimum of timestampLabel', + operationType: 'min', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + sourceField: 'timestamp', + }, + }, + incompleteColumns: {}, + indexPatternId: 'first', + }, + }, + }); + }); + it('duplicate_incompatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'newCol', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + dropType: 'duplicate_incompatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5', 'newCol'], + columns: { + ...props.state.layers.second.columns, + newCol: { + dataType: 'date', + isBucketed: false, + label: 'Minimum of timestampLabel', + operationType: 'min', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + sourceField: 'timestamp', + }, + }, + incompleteColumns: {}, + indexPatternId: 'first', + }, + }, + }); + }); + it('swap_incompatible: allows dropping to compatible group to replace an existing column', () => { + props = { + ...props, + target: { + ...props.target, + columnId: 'col5', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + dropType: 'swap_incompatible', + }; + + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...props.state.layers.first, + columns: { + ...props.state.layers.first.columns, + col1: { + dataType: 'number', + isBucketed: true, + label: 'bytes', + operationType: 'range', + params: { + includeEmptyRows: true, + maxBars: 'auto', + ranges: [ + { + from: 0, + label: '', + to: 1000, + }, + ], + type: 'histogram', + }, + scale: 'interval', + sourceField: 'bytes', + }, + }, + }, + second: { + columnOrder: ['col2', 'col3', 'col4', 'col5'], + columns: { + ...props.state.layers.second.columns, + col5: { + dataType: 'date', + isBucketed: false, + label: 'Minimum of timestampLabel', + operationType: 'min', + params: { + emptyAsNull: true, + }, + scale: 'ratio', + sourceField: 'timestamp', + }, + }, + incompleteColumns: {}, + indexPatternId: 'first', + }, + }, + }); + }); + it('combine_compatible: allows dropping to combine to multiterms', () => { + onDrop({ + ...props, + state: { + ...props.state, + layers: { + ...props.state.layers, + first: { + ...props.state.layers.first, + columns: { + terms1: mockedColumns.terms, + }, + }, + }, + }, + source: { + columnId: 'terms1', + groupId: 'a', + layerId: 'first', + id: 'terms1', + humanData: { label: 'Label' }, + }, + dropType: 'combine_compatible', + target: { + ...props.target, + columnId: 'col4', + groupId: 'a', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + }); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { ...mockedLayers.emptyLayer(), incompleteColumns: {} }, + second: { + ...props.state.layers.second, + incompleteColumns: {}, + columns: { + ...props.state.layers.second.columns, + col4: { + dataType: 'string', + isBucketed: true, + label: 'Top values of dest + 1 other', + operationType: 'terms', + params: { + orderBy: { + type: 'alphabetical', + }, + orderDirection: 'desc', + parentFormat: { + id: 'multi_terms', + }, + secondaryFields: ['src'], + size: 10, + }, + sourceField: 'dest', + }, + }, + }, + }, + }); + }); + it('combine_incompatible: allows dropping to combine to multiterms', () => { + onDrop({ + ...props, + state: { + ...props.state, + layers: { + ...props.state.layers, + first: { + ...props.state.layers.first, + columns: { + median: mockedColumns.median, + }, + }, + }, + }, + source: { + columnId: 'median', + groupId: 'x', + layerId: 'first', + id: 'median', + humanData: { label: 'Label' }, + filterOperations: (op: OperationMetadata) => !op.isBucketed, + }, + dropType: 'combine_incompatible', + target: { + ...props.target, + columnId: 'col4', + groupId: 'breakdown', + filterOperations: (op: OperationMetadata) => op.isBucketed, + }, + }); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { ...mockedLayers.emptyLayer(), incompleteColumns: {} }, + second: { + ...props.state.layers.second, + incompleteColumns: {}, + columns: { + ...props.state.layers.second.columns, + col4: { + dataType: 'string', + isBucketed: true, + label: 'Top values of dest + 1 other', + operationType: 'terms', + params: { + orderBy: { + type: 'alphabetical', + }, + orderDirection: 'desc', + parentFormat: { + id: 'multi_terms', + }, + secondaryFields: ['bytes'], + size: 10, + }, + sourceField: 'dest', + }, + }, + }, + }, + }); + }); + }); + describe('references', () => { + let props: DatasourceDimensionDropHandlerProps; + beforeEach(() => { + props = { + dimensionGroups: defaultDimensionGroups, + setState: jest.fn(), + dropType: 'move_compatible', + + state: { + layers: { + first: { + indexPatternId: 'first', + columns: { + firstColumnX0: { + label: 'Part of count()', + dataType: 'number', + operationType: 'count', + isBucketed: false, + scale: 'ratio', + sourceField: '___records___', + customLabel: true, + }, + firstColumn: { + label: 'count()', + dataType: 'number', + operationType: 'formula', + isBucketed: false, + scale: 'ratio', + params: { formula: 'count()' }, + references: ['firstColumnX0'], + } as FormulaIndexPatternColumn, + }, + columnOrder: ['firstColumn', 'firstColumnX0'], + incompleteColumns: {}, + }, + second: { + indexPatternId: 'first', + columns: { + secondX0: { + label: 'Part of count()', + dataType: 'number', + operationType: 'count', + isBucketed: false, + scale: 'ratio', + sourceField: '___records___', + customLabel: true, + }, + second: { + label: 'count()', + dataType: 'number', + operationType: 'formula', + isBucketed: false, + scale: 'ratio', + params: { formula: 'count()' }, + references: ['secondX0'], + } as FormulaIndexPatternColumn, + }, + columnOrder: ['second', 'secondX0'], + }, + }, + indexPatternRefs: [], + indexPatterns: mockDataViews(), + currentIndexPatternId: 'first', + isFirstExistenceFetch: false, + existingFields: { + first: { + timestamp: true, + bytes: true, + memory: true, + source: true, + }, + }, + }, + source: { + columnId: 'firstColumn', + groupId: 'y', + layerId: 'first', + id: 'firstColumn', + humanData: { + label: 'count()', + }, + }, + target: { + columnId: 'newColumn', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + }; + + jest.clearAllMocks(); + }); + + it('move_compatible; allows dropping to the compatible group in different layer to empty column', () => { + expect(onDrop(props)).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['second', 'secondX0', 'newColumnX0', 'newColumn'], + columns: { + ...props.state.layers.second.columns, + newColumn: { + dataType: 'number', + isBucketed: false, + label: 'count()', + operationType: 'formula', + params: { + formula: 'count()', + isFormulaBroken: false, + }, + references: ['newColumnX0'], + scale: 'ratio', + }, + newColumnX0: { + customLabel: true, + dataType: 'number', + filter: undefined, + isBucketed: false, + label: 'Part of count()', + operationType: 'count', + params: { + emptyAsNull: false, + }, + scale: 'ratio', + sourceField: '___records___', + timeScale: undefined, + timeShift: undefined, + }, + }, + indexPatternId: 'first', + }, + }, + }); + }); + it('replace_compatible: allows dropping to compatible group to replace an existing column', () => { + expect( + onDrop({ + ...props, + target: { + columnId: 'second', + groupId: 'y', + layerId: 'second', + filterOperations: (op) => !op.isBucketed, + }, + }) + ).toEqual(true); + expect(props.setState).toBeCalledTimes(1); + expect(props.setState).toHaveBeenCalledWith({ + ...props.state, + layers: { + ...props.state.layers, + first: { + ...mockedLayers.emptyLayer(), + incompleteColumns: {}, + }, + second: { + columnOrder: ['second', 'secondX0'], + columns: { + ...props.state.layers.second.columns, + second: { + dataType: 'number', + isBucketed: false, + label: 'count()', + operationType: 'formula', + params: { + formula: 'count()', + isFormulaBroken: false, + }, + references: ['secondX0'], + scale: 'ratio', + }, + secondX0: { + customLabel: true, + dataType: 'number', + filter: undefined, + isBucketed: false, + label: 'Part of count()', + operationType: 'count', + params: { + emptyAsNull: false, + }, + scale: 'ratio', + sourceField: '___records___', + timeScale: undefined, + timeShift: undefined, + }, + }, + indexPatternId: 'first', + }, + }, + }); + }); + }); + }); + }); +}); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.ts index c9e806050caad..3d57e21e73387 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/on_drop_handler.ts @@ -4,7 +4,14 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { DatasourceDimensionDropHandlerProps, DraggedOperation } from '../../../types'; +import { + DatasourceDimensionDropHandlerProps, + DragDropOperation, + DropType, + isOperation, + StateSetter, + VisualizationDimensionGroupConfig, +} from '../../../types'; import { insertOrReplaceColumn, deleteColumn, @@ -14,160 +21,125 @@ import { hasOperationSupportForMultipleFields, getOperationHelperForMultipleFields, replaceColumn, + deleteColumnInLayers, } from '../../operations'; -import { mergeLayer } from '../../state_helpers'; +import { mergeLayer, mergeLayers } from '../../state_helpers'; import { isDraggedField } from '../../pure_utils'; import { getNewOperation, getField } from './get_drop_props'; -import { IndexPatternPrivateState, DraggedField } from '../../types'; +import { IndexPatternPrivateState, DraggedField, DataViewDragDropOperation } from '../../types'; import { trackUiEvent } from '../../../lens_ui_telemetry'; -type DropHandlerProps = DatasourceDimensionDropHandlerProps & { - droppedItem: T; -}; +interface DropHandlerProps { + state: IndexPatternPrivateState; + setState: StateSetter< + IndexPatternPrivateState, + { + isDimensionComplete?: boolean; + forceRender?: boolean; + } + >; + dimensionGroups: VisualizationDimensionGroupConfig[]; + dropType?: DropType; + source: T; + target: DataViewDragDropOperation; +} export function onDrop(props: DatasourceDimensionDropHandlerProps) { - const { droppedItem, dropType } = props; - - if (dropType === 'field_add' || dropType === 'field_replace' || dropType === 'field_combine') { - return operationOnDropMap[dropType]({ - ...props, - droppedItem: droppedItem as DraggedField, - }); + const { target, source, dropType, state } = props; + + if (isDraggedField(source) && isFieldDropType(dropType)) { + return onFieldDrop( + { + ...props, + target: { + ...target, + dataView: state.indexPatterns[state.layers[target.layerId].indexPatternId], + }, + source, + }, + dropType === 'field_combine' + ); } - return operationOnDropMap[dropType]({ - ...props, - droppedItem: droppedItem as DraggedOperation, - }); -} - -const operationOnDropMap = { - field_add: onFieldDrop, - field_replace: onFieldDrop, - field_combine: (props: DropHandlerProps) => onFieldDrop(props, true), - - reorder: onReorder, - - move_compatible: (props: DropHandlerProps) => onMoveCompatible(props, true), - replace_compatible: (props: DropHandlerProps) => onMoveCompatible(props, true), - duplicate_compatible: onMoveCompatible, - replace_duplicate_compatible: onMoveCompatible, - move_incompatible: (props: DropHandlerProps) => onMoveIncompatible(props, true), - replace_incompatible: (props: DropHandlerProps) => - onMoveIncompatible(props, true), - duplicate_incompatible: onMoveIncompatible, - replace_duplicate_incompatible: onMoveIncompatible, - - swap_compatible: onSwapCompatible, - swap_incompatible: onSwapIncompatible, - combine_compatible: onCombineCompatible, - combine_incompatible: onCombineCompatible, -}; - -function onCombineCompatible({ - columnId, - setState, - state, - layerId, - droppedItem, - dimensionGroups, - groupId, -}: DropHandlerProps) { - const layer = state.layers[layerId]; - const sourceId = droppedItem.columnId; - const targetId = columnId; - const indexPattern = state.indexPatterns[layer.indexPatternId]; - const sourceColumn = layer.columns[sourceId]; - const targetColumn = layer.columns[targetId]; - - // extract the field from the source column - const sourceField = getField(sourceColumn, indexPattern); - const targetField = getField(targetColumn, indexPattern); - if (!sourceField || !targetField) { + if (!isOperation(source)) { + return false; + } + const sourceDataView = state.indexPatterns[state.layers[source.layerId].indexPatternId]; + const targetDataView = state.indexPatterns[state.layers[target.layerId].indexPatternId]; + if (sourceDataView !== targetDataView) { return false; } - // pass it to the target column and delete the source column - const initialParams = { - params: - getOperationHelperForMultipleFields(targetColumn.operationType)?.({ - targetColumn, - sourceColumn, - indexPattern, - }) ?? {}, - }; - - const modifiedLayer = replaceColumn({ - layer, - columnId, - indexPattern, - op: targetColumn.operationType, - field: targetField, - visualizationGroups: dimensionGroups, - targetGroup: groupId, - initialParams, - shouldCombineField: true, - }); - const newLayer = deleteColumn({ - layer: modifiedLayer, - columnId: sourceId, - indexPattern, - }); - // Time to replace - setState( - mergeLayer({ - state, - layerId, - newLayer, - }) - ); + const operationProps = { + ...props, + target: { + ...target, + dataView: targetDataView, + }, + source: { + ...source, + dataView: sourceDataView, + }, + }; + if (dropType === 'reorder') { + return onReorder(operationProps); + } - return { deleted: sourceId }; + if (['move_compatible', 'replace_compatible'].includes(dropType)) { + return onMoveCompatible(operationProps, true); + } + if (['duplicate_compatible', 'replace_duplicate_compatible'].includes(dropType)) { + return onMoveCompatible(operationProps); + } + if (['move_incompatible', 'replace_incompatible'].includes(dropType)) { + return onMoveIncompatible(operationProps, true); + } + if (['duplicate_incompatible', 'replace_duplicate_incompatible'].includes(dropType)) { + return onMoveIncompatible(operationProps); + } + if (dropType === 'swap_compatible') { + return onSwapCompatible(operationProps); + } + if (dropType === 'swap_incompatible') { + return onSwapIncompatible(operationProps); + } + if (['combine_incompatible', 'combine_compatible'].includes(dropType)) { + return onCombine(operationProps); + } } +const isFieldDropType = (dropType: DropType) => + ['field_add', 'field_replace', 'field_combine'].includes(dropType); + function onFieldDrop(props: DropHandlerProps, shouldAddField?: boolean) { - const { - columnId, - setState, - state, - layerId, - droppedItem, - filterOperations, - groupId, - dimensionGroups, - } = props; + const { setState, state, source, target, dimensionGroups } = props; const prioritizedOperation = dimensionGroups.find( - (g) => g.groupId === groupId + (g) => g.groupId === target.groupId )?.prioritizedOperation; - const layer = state.layers[layerId]; + const layer = state.layers[target.layerId]; const indexPattern = state.indexPatterns[layer.indexPatternId]; - const targetColumn = layer.columns[columnId]; + const targetColumn = layer.columns[target.columnId]; const newOperation = shouldAddField ? targetColumn.operationType - : getNewOperation(droppedItem.field, filterOperations, targetColumn, prioritizedOperation); + : getNewOperation(source.field, target.filterOperations, targetColumn, prioritizedOperation); if ( - !isDraggedField(droppedItem) || + !isDraggedField(source) || !newOperation || (shouldAddField && - !hasOperationSupportForMultipleFields( - indexPattern, - targetColumn, - undefined, - droppedItem.field - )) + !hasOperationSupportForMultipleFields(indexPattern, targetColumn, undefined, source.field)) ) { return false; } - const field = shouldAddField ? getField(targetColumn, indexPattern) : droppedItem.field; + const field = shouldAddField ? getField(targetColumn, indexPattern) : source.field; const initialParams = shouldAddField ? { params: getOperationHelperForMultipleFields(targetColumn.operationType)?.({ targetColumn, - field: droppedItem.field, + field: source.field, indexPattern, }) || {}, } @@ -175,12 +147,12 @@ function onFieldDrop(props: DropHandlerProps, shouldAddField?: boo const newLayer = insertOrReplaceColumn({ layer, - columnId, + columnId: target.columnId, indexPattern, op: newOperation, field, visualizationGroups: dimensionGroups, - targetGroup: groupId, + targetGroup: target.groupId, shouldCombineField: shouldAddField, initialParams, }); @@ -188,82 +160,76 @@ function onFieldDrop(props: DropHandlerProps, shouldAddField?: boo trackUiEvent('drop_onto_dimension'); const hasData = Object.values(state.layers).some(({ columns }) => columns.length); trackUiEvent(hasData ? 'drop_non_empty' : 'drop_empty'); - setState(mergeLayer({ state, layerId, newLayer })); + setState(mergeLayer({ state, layerId: target.layerId, newLayer })); return true; } function onMoveCompatible( - { - columnId, - setState, - state, - layerId, - droppedItem, - dimensionGroups, - groupId, - }: DropHandlerProps, + { setState, state, source, target, dimensionGroups }: DropHandlerProps, shouldDeleteSource?: boolean ) { - const layer = state.layers[layerId]; - const sourceColumn = layer.columns[droppedItem.columnId]; - const indexPattern = state.indexPatterns[layer.indexPatternId]; - - const modifiedLayer = copyColumn({ - layer, - targetId: columnId, - sourceColumnId: droppedItem.columnId, - sourceColumn, + const modifiedLayers = copyColumn({ + layers: state.layers, + target, + source, shouldDeleteSource, - indexPattern, }); - const updatedColumnOrder = reorderByGroups( - dimensionGroups, - groupId, - getColumnOrder(modifiedLayer), - columnId - ); + if (target.layerId === source.layerId) { + const updatedColumnOrder = reorderByGroups( + dimensionGroups, + getColumnOrder(modifiedLayers[target.layerId]), + target.groupId, + target.columnId + ); + + const newLayer = { + ...modifiedLayers[target.layerId], + columnOrder: updatedColumnOrder, + columns: modifiedLayers[target.layerId].columns, + }; + + // Time to replace + setState( + mergeLayer({ + state, + layerId: target.layerId, + newLayer, + }) + ); + return true; + } else { + setState(mergeLayers({ state, newLayers: modifiedLayers })); - // Time to replace - setState( - mergeLayer({ - state, - layerId, - newLayer: { - columnOrder: updatedColumnOrder, - columns: modifiedLayer.columns, - }, - }) - ); - return shouldDeleteSource ? { deleted: droppedItem.columnId } : true; + return true; + } } function onReorder({ - columnId, setState, state, - layerId, - droppedItem, -}: DropHandlerProps) { - function reorderElements(items: string[], dest: string, src: string) { - const result = items.filter((c) => c !== src); - const targetIndex = items.findIndex((c) => c === src); - const sourceIndex = items.findIndex((c) => c === dest); - - const targetPosition = result.indexOf(dest); - result.splice(targetIndex < sourceIndex ? targetPosition + 1 : targetPosition, 0, src); + source, + target, +}: DropHandlerProps) { + function reorderElements(items: string[], targetId: string, sourceId: string) { + const result = items.filter((c) => c !== sourceId); + const targetIndex = items.findIndex((c) => c === sourceId); + const sourceIndex = items.findIndex((c) => c === targetId); + + const targetPosition = result.indexOf(targetId); + result.splice(targetIndex < sourceIndex ? targetPosition + 1 : targetPosition, 0, sourceId); return result; } setState( mergeLayer({ state, - layerId, + layerId: target.layerId, newLayer: { columnOrder: reorderElements( - state.layers[layerId].columnOrder, - columnId, - droppedItem.columnId + state.layers[target.layerId].columnOrder, + target.columnId, + source.columnId ), }, }) @@ -272,124 +238,158 @@ function onReorder({ } function onMoveIncompatible( - { - columnId, - setState, - state, - layerId, - droppedItem, - filterOperations, - dimensionGroups, - groupId, - }: DropHandlerProps, + { setState, state, source, dimensionGroups, target }: DropHandlerProps, shouldDeleteSource?: boolean ) { - const layer = state.layers[layerId]; - const indexPattern = state.indexPatterns[layer.indexPatternId]; - const sourceColumn = layer.columns[droppedItem.columnId]; - const targetColumn = layer.columns[columnId] || null; - + const targetLayer = state.layers[target.layerId]; + const targetColumn = targetLayer.columns[target.columnId] || null; + const sourceLayer = state.layers[source.layerId]; + const indexPattern = state.indexPatterns[sourceLayer.indexPatternId]; + const sourceColumn = sourceLayer.columns[source.columnId]; const sourceField = getField(sourceColumn, indexPattern); - const newOperation = getNewOperation(sourceField, filterOperations, targetColumn); + const newOperation = getNewOperation(sourceField, target.filterOperations, targetColumn); if (!newOperation) { return false; } - const modifiedLayer = shouldDeleteSource + const outputSourceLayer = shouldDeleteSource ? deleteColumn({ - layer, - columnId: droppedItem.columnId, + layer: sourceLayer, + columnId: source.columnId, indexPattern, }) - : layer; + : sourceLayer; - const newLayer = insertOrReplaceColumn({ - layer: modifiedLayer, - columnId, - indexPattern, - op: newOperation, - field: sourceField, - visualizationGroups: dimensionGroups, - targetGroup: groupId, - shouldResetLabel: true, - }); + if (target.layerId === source.layerId) { + const newLayer = insertOrReplaceColumn({ + layer: outputSourceLayer, + columnId: target.columnId, + indexPattern, + op: newOperation, + field: sourceField, + visualizationGroups: dimensionGroups, + targetGroup: target.groupId, + shouldResetLabel: true, + }); - trackUiEvent('drop_onto_dimension'); - setState( - mergeLayer({ - state, - layerId, - newLayer, - }) - ); - return shouldDeleteSource ? { deleted: droppedItem.columnId } : true; + trackUiEvent('drop_onto_dimension'); + setState( + mergeLayer({ + state, + layerId: target.layerId, + newLayer, + }) + ); + return true; + } else { + const outputTargetLayer = insertOrReplaceColumn({ + layer: targetLayer, + columnId: target.columnId, + indexPattern, + op: newOperation, + field: sourceField, + visualizationGroups: dimensionGroups, + targetGroup: target.groupId, + shouldResetLabel: true, + }); + + trackUiEvent('drop_onto_dimension'); + setState( + mergeLayers({ + state, + newLayers: { + [source.layerId]: outputSourceLayer, + [target.layerId]: outputTargetLayer, + }, + }) + ); + return true; + } } function onSwapIncompatible({ - columnId, setState, state, - layerId, - droppedItem, - filterOperations, + source, dimensionGroups, - groupId, -}: DropHandlerProps) { - const layer = state.layers[layerId]; - const indexPattern = state.indexPatterns[layer.indexPatternId]; - const sourceColumn = layer.columns[droppedItem.columnId]; - const targetColumn = layer.columns[columnId]; + target, +}: DropHandlerProps) { + const targetLayer = state.layers[target.layerId]; + const sourceLayer = state.layers[source.layerId]; + const indexPattern = state.indexPatterns[targetLayer.indexPatternId]; + const sourceColumn = sourceLayer.columns[source.columnId]; + const targetColumn = targetLayer.columns[target.columnId]; const sourceField = getField(sourceColumn, indexPattern); const targetField = getField(targetColumn, indexPattern); - const newOperationForSource = getNewOperation(sourceField, filterOperations, targetColumn); - const newOperationForTarget = getNewOperation( - targetField, - droppedItem.filterOperations, - sourceColumn - ); + const newOperationForSource = getNewOperation(sourceField, target.filterOperations, targetColumn); + const newOperationForTarget = getNewOperation(targetField, source.filterOperations, sourceColumn); if (!newOperationForSource || !newOperationForTarget) { return false; } - const newLayer = insertOrReplaceColumn({ - layer: insertOrReplaceColumn({ - layer, - columnId, - targetGroup: groupId, - indexPattern, - op: newOperationForSource, - field: sourceField, - visualizationGroups: dimensionGroups, - shouldResetLabel: true, - }), - columnId: droppedItem.columnId, + const outputTargetLayer = insertOrReplaceColumn({ + layer: targetLayer, + columnId: target.columnId, + targetGroup: target.groupId, indexPattern, - op: newOperationForTarget, - field: targetField, + op: newOperationForSource, + field: sourceField, visualizationGroups: dimensionGroups, - targetGroup: droppedItem.groupId, shouldResetLabel: true, }); - trackUiEvent('drop_onto_dimension'); - setState( - mergeLayer({ - state, - layerId, - newLayer, - }) - ); - return true; + if (source.layerId === target.layerId) { + const newLayer = insertOrReplaceColumn({ + layer: outputTargetLayer, + columnId: source.columnId, + indexPattern, + op: newOperationForTarget, + field: targetField, + visualizationGroups: dimensionGroups, + targetGroup: source.groupId, + shouldResetLabel: true, + }); + + trackUiEvent('drop_onto_dimension'); + setState( + mergeLayer({ + state, + layerId: target.layerId, + newLayer, + }) + ); + return true; + } else { + const outputSourceLayer = insertOrReplaceColumn({ + layer: sourceLayer, + columnId: source.columnId, + indexPattern, + op: newOperationForTarget, + field: targetField, + visualizationGroups: dimensionGroups, + targetGroup: source.groupId, + shouldResetLabel: true, + }); + + trackUiEvent('drop_onto_dimension'); + setState( + mergeLayers({ + state, + newLayers: { [source.layerId]: outputSourceLayer, [target.layerId]: outputTargetLayer }, + }) + ); + return true; + } } const swapColumnOrder = (columnOrder: string[], sourceId: string, targetId: string) => { - const newColumnOrder = [...columnOrder]; - const sourceIndex = newColumnOrder.findIndex((c) => c === sourceId); - const targetIndex = newColumnOrder.findIndex((c) => c === targetId); + const sourceIndex = columnOrder.findIndex((c) => c === sourceId); + const targetIndex = columnOrder.findIndex((c) => c === targetId); + const newColumnOrder = [...columnOrder]; newColumnOrder[sourceIndex] = targetId; newColumnOrder[targetIndex] = sourceId; @@ -397,38 +397,114 @@ const swapColumnOrder = (columnOrder: string[], sourceId: string, targetId: stri }; function onSwapCompatible({ - columnId, setState, state, - layerId, - droppedItem, + source, dimensionGroups, - groupId, -}: DropHandlerProps) { - const layer = state.layers[layerId]; - const sourceId = droppedItem.columnId; - const targetId = columnId; - - const sourceColumn = { ...layer.columns[sourceId] }; - const targetColumn = { ...layer.columns[targetId] }; - const newColumns = { ...layer.columns }; - newColumns[targetId] = sourceColumn; - newColumns[sourceId] = targetColumn; - - let updatedColumnOrder = swapColumnOrder(layer.columnOrder, sourceId, targetId); - updatedColumnOrder = reorderByGroups(dimensionGroups, groupId, updatedColumnOrder, columnId); - - // Time to replace - setState( - mergeLayer({ - state, - layerId, - newLayer: { - columnOrder: updatedColumnOrder, - columns: newColumns, - }, - }) - ); + target, +}: DropHandlerProps) { + if (target.layerId === source.layerId) { + const layer = state.layers[target.layerId]; + const newColumns = { + ...layer.columns, + [target.columnId]: { ...layer.columns[source.columnId] }, + [source.columnId]: { ...layer.columns[target.columnId] }, + }; + + let updatedColumnOrder = swapColumnOrder(layer.columnOrder, source.columnId, target.columnId); + updatedColumnOrder = reorderByGroups( + dimensionGroups, + updatedColumnOrder, + target.groupId, + target.columnId + ); + + setState( + mergeLayer({ + state, + layerId: target.layerId, + newLayer: { + columnOrder: updatedColumnOrder, + columns: newColumns, + }, + }) + ); + + return true; + } else { + const newTargetLayer = copyColumn({ + layers: state.layers, + target, + source, + shouldDeleteSource: true, + })[target.layerId]; + + const newSourceLayer = copyColumn({ + layers: state.layers, + target: source, + source: target, + shouldDeleteSource: true, + })[source.layerId]; + + setState( + mergeLayers({ + state, + newLayers: { + [source.layerId]: newSourceLayer, + [target.layerId]: newTargetLayer, + }, + }) + ); + + return true; + } +} + +function onCombine({ + state, + setState, + source, + target, + dimensionGroups, +}: DropHandlerProps) { + const targetLayer = state.layers[target.layerId]; + const targetColumn = targetLayer.columns[target.columnId]; + const targetField = getField(targetColumn, target.dataView); + const indexPattern = state.indexPatterns[targetLayer.indexPatternId]; + + const sourceLayer = state.layers[source.layerId]; + const sourceColumn = sourceLayer.columns[source.columnId]; + const sourceField = getField(sourceColumn, indexPattern); + // extract the field from the source column + if (!sourceField || !targetField) { + return false; + } + // pass it to the target column and delete the source column + const initialParams = { + params: + getOperationHelperForMultipleFields(targetColumn.operationType)?.({ + targetColumn, + sourceColumn, + indexPattern, + }) ?? {}, + }; + const outputTargetLayer = replaceColumn({ + layer: targetLayer, + columnId: target.columnId, + indexPattern, + op: targetColumn.operationType, + field: targetField, + visualizationGroups: dimensionGroups, + targetGroup: target.groupId, + initialParams, + shouldCombineField: true, + }); + + const newLayers = deleteColumnInLayers({ + layers: { ...state.layers, [target.layerId]: outputTargetLayer }, + source, + }); + setState(mergeLayers({ state, newLayers })); return true; } diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/operation_support.ts b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/operation_support.ts index 7a7297e77bcf2..2f703547219ec 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/operation_support.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/operation_support.ts @@ -18,9 +18,9 @@ export interface OperationSupportMatrix { } type Props = Pick< - DatasourceDimensionDropProps, - 'layerId' | 'columnId' | 'state' | 'filterOperations' ->; + DatasourceDimensionDropProps['target'], + 'layerId' | 'columnId' | 'filterOperations' +> & { state: IndexPatternPrivateState }; function computeOperationMatrix( operationsByMetadata: Array<{ diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts index 6806b1ce47795..a37976f6d8069 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.test.ts @@ -33,6 +33,7 @@ import { FormulaIndexPatternColumn, RangeIndexPatternColumn, FiltersIndexPatternColumn, + PercentileIndexPatternColumn, } from './operations'; import { createMockedFullReference } from './operations/mocks'; import { cloneDeep } from 'lodash'; @@ -491,10 +492,10 @@ describe('IndexPattern Data Source', () => { Object { "arguments": Object { "idMap": Array [ - "{\\"col-0-0\\":{\\"label\\":\\"Count of records\\",\\"dataType\\":\\"number\\",\\"isBucketed\\":false,\\"sourceField\\":\\"___records___\\",\\"operationType\\":\\"count\\",\\"id\\":\\"col1\\"},\\"col-1-1\\":{\\"label\\":\\"Date\\",\\"dataType\\":\\"date\\",\\"isBucketed\\":true,\\"operationType\\":\\"date_histogram\\",\\"sourceField\\":\\"timestamp\\",\\"params\\":{\\"interval\\":\\"1d\\"},\\"id\\":\\"col2\\"}}", + "{\\"col-0-0\\":[{\\"label\\":\\"Count of records\\",\\"dataType\\":\\"number\\",\\"isBucketed\\":false,\\"sourceField\\":\\"___records___\\",\\"operationType\\":\\"count\\",\\"id\\":\\"col1\\"}],\\"col-1-1\\":[{\\"label\\":\\"Date\\",\\"dataType\\":\\"date\\",\\"isBucketed\\":true,\\"operationType\\":\\"date_histogram\\",\\"sourceField\\":\\"timestamp\\",\\"params\\":{\\"interval\\":\\"1d\\"},\\"id\\":\\"col2\\"}]}", ], }, - "function": "lens_rename_columns", + "function": "lens_map_to_columns", "type": "function", }, ], @@ -905,9 +906,9 @@ describe('IndexPattern Data Source', () => { const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; expect(ast.chain[1].arguments.metricsAtAllLevels).toEqual([false]); expect(JSON.parse(ast.chain[2].arguments.idMap[0] as string)).toEqual({ - 'col-0-0': expect.objectContaining({ id: 'bucket1' }), - 'col-1-1': expect.objectContaining({ id: 'bucket2' }), - 'col-2-2': expect.objectContaining({ id: 'metric' }), + 'col-0-0': [expect.objectContaining({ id: 'bucket1' })], + 'col-1-1': [expect.objectContaining({ id: 'bucket2' })], + 'col-2-2': [expect.objectContaining({ id: 'metric' })], }); }); @@ -948,6 +949,140 @@ describe('IndexPattern Data Source', () => { expect(ast.chain[1].arguments.timeFields).not.toContain('timefield'); }); + it('should call optimizeEsAggs once per operation for which it is available', () => { + const queryBaseState: DataViewBaseState = { + currentIndexPatternId: '1', + layers: { + first: { + indexPatternId: '1', + columns: { + col1: { + label: 'timestamp', + dataType: 'date', + operationType: 'date_histogram', + sourceField: 'timestamp', + isBucketed: true, + scale: 'interval', + params: { + interval: 'auto', + includeEmptyRows: true, + dropPartials: false, + }, + } as DateHistogramIndexPatternColumn, + col2: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + col3: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + }, + columnOrder: ['col1', 'col2', 'col3'], + incompleteColumns: {}, + }, + }, + }; + + const state = enrichBaseState(queryBaseState); + + const optimizeMock = jest.spyOn(operationDefinitionMap.percentile, 'optimizeEsAggs'); + + indexPatternDatasource.toExpression(state, 'first'); + + expect(operationDefinitionMap.percentile.optimizeEsAggs).toHaveBeenCalledTimes(1); + + optimizeMock.mockRestore(); + }); + + it('should update anticipated esAggs column IDs based on the order of the optimized agg expression builders', () => { + const queryBaseState: DataViewBaseState = { + currentIndexPatternId: '1', + layers: { + first: { + indexPatternId: '1', + columns: { + col1: { + label: 'timestamp', + dataType: 'date', + operationType: 'date_histogram', + sourceField: 'timestamp', + isBucketed: true, + scale: 'interval', + params: { + interval: 'auto', + includeEmptyRows: true, + dropPartials: false, + }, + } as DateHistogramIndexPatternColumn, + col2: { + label: '95th percentile of bytes', + dataType: 'number', + operationType: 'percentile', + sourceField: 'bytes', + isBucketed: false, + scale: 'ratio', + params: { + percentile: 95, + }, + } as PercentileIndexPatternColumn, + col3: { + label: 'Count of records', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + timeScale: 'h', + }, + col4: { + label: 'Count of records2', + dataType: 'number', + isBucketed: false, + sourceField: '___records___', + operationType: 'count', + timeScale: 'h', + }, + }, + columnOrder: ['col1', 'col2', 'col3', 'col4'], + incompleteColumns: {}, + }, + }, + }; + + const state = enrichBaseState(queryBaseState); + + const optimizeMock = jest + .spyOn(operationDefinitionMap.percentile, 'optimizeEsAggs') + .mockImplementation((aggs, esAggsIdMap) => { + // change the order of the aggregations + return { aggs: aggs.reverse(), esAggsIdMap }; + }); + + const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; + + expect(operationDefinitionMap.percentile.optimizeEsAggs).toHaveBeenCalledTimes(1); + + const idMap = JSON.parse(ast.chain[2].arguments.idMap as unknown as string); + + expect(Object.keys(idMap)).toEqual(['col-0-3', 'col-1-2', 'col-2-1', 'col-3-0']); + + optimizeMock.mockRestore(); + }); + describe('references', () => { beforeEach(() => { // @ts-expect-error we are inserting an invalid type @@ -1026,10 +1161,13 @@ describe('IndexPattern Data Source', () => { const state = enrichBaseState(queryBaseState); const ast = indexPatternDatasource.toExpression(state, 'first') as Ast; + expect(JSON.parse(ast.chain[2].arguments.idMap[0] as string)).toEqual({ - 'col-0-0': expect.objectContaining({ - id: 'col1', - }), + 'col-0-0': [ + expect.objectContaining({ + id: 'col1', + }), + ], }); }); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/layerpanel.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/layerpanel.test.tsx index dba57f2fcb03e..d0c8e1ffafd69 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/layerpanel.test.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/layerpanel.test.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React from 'react'; +import React, { MouseEvent } from 'react'; import { IndexPatternPrivateState } from './types'; import { IndexPatternLayerPanelProps, LayerPanel } from './layerpanel'; import { shallowWithIntl as shallow } from '@kbn/test-jest-helpers'; @@ -224,13 +224,14 @@ describe('Layer Data Panel', () => { } function selectIndexPatternPickerOption(instance: ShallowWrapper, selectedLabel: string) { + const event = {} as MouseEvent; const options: IndexPatternPickerOption[] = getIndexPatternPickerOptions(instance).map( (option: IndexPatternPickerOption) => option.label === selectedLabel ? { ...option, checked: 'on' } : { ...option, checked: undefined } ); - return getIndexPatternPickerList(instance).prop('onChange')!(options); + return getIndexPatternPickerList(instance).prop('onChange')!(options, event); } function getIndexPatternPickerOptions(instance: ShallowWrapper) { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx index 437ee4bf8b22d..104b85651a876 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx @@ -150,12 +150,8 @@ export const countOperation: OperationDefinition - adjustTimeScaleOnOtherColumnChange( - layer, - thisColumnId, - changedColumnId - ), + onOtherColumnChanged: (layer, thisColumnId) => + adjustTimeScaleOnOtherColumnChange(layer, thisColumnId), toEsAggsFn: (column, columnId) => { return buildExpressionFunction('aggCount', { id: columnId, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/formula.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/formula.tsx index 1d08873a160e9..72aace21479ac 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/formula.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/formula.tsx @@ -174,13 +174,23 @@ export const formulaOperation: OperationDefinition { return true; }, - createCopy(layer, sourceId, targetId, indexPattern, operationDefinitionMap) { - const currentColumn = layer.columns[sourceId] as FormulaIndexPatternColumn; - - return insertOrReplaceFormulaColumn(targetId, currentColumn, layer, { - indexPattern, - operations: operationDefinitionMap, - }).layer; + createCopy(layers, source, target, operationDefinitionMap) { + const currentColumn = layers[source.layerId].columns[ + source.columnId + ] as FormulaIndexPatternColumn; + const modifiedLayer = insertOrReplaceFormulaColumn( + target.columnId, + currentColumn, + layers[target.layerId], + { + indexPattern: target.dataView, + operations: operationDefinitionMap, + } + ); + return { + ...layers, + [target.layerId]: modifiedLayer.layer, + }; }, timeScalingMode: 'optional', paramEditor: WrappedFormulaEditor, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/math.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/math.tsx index 85c2ea707b123..d7f25275f63a2 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/math.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/formula/math.tsx @@ -67,8 +67,8 @@ export const mathOperation: OperationDefinition { - return { ...layer }; + createCopy: (layers) => { + return { ...layers }; }, }; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts index 6ca79009ff95b..cdf2b0249529e 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts @@ -12,7 +12,10 @@ import { CoreStart, } from '@kbn/core/public'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; -import { ExpressionAstFunction } from '@kbn/expressions-plugin/public'; +import { + ExpressionAstExpressionBuilder, + ExpressionAstFunction, +} from '@kbn/expressions-plugin/public'; import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; @@ -51,10 +54,16 @@ import type { GenericIndexPatternColumn, ReferenceBasedIndexPatternColumn, } from './column_types'; -import { IndexPattern, IndexPatternField, IndexPatternLayer } from '../../types'; +import { + DataViewDragDropOperation, + IndexPattern, + IndexPatternField, + IndexPatternLayer, +} from '../../types'; import { DateRange, LayerType } from '../../../../common'; import { rangeOperation } from './ranges'; import { IndexPatternDimensionEditorProps, OperationSupportMatrix } from '../../dimension_panel'; +import type { OriginalColumn } from '../../to_expression'; export type { IncompleteColumn, @@ -245,11 +254,7 @@ interface BaseOperationDefinitionProps * Based on the current column and the other updated columns, this function has to * return an updated column. If not implemented, the `id` function is used instead. */ - onOtherColumnChanged?: ( - layer: IndexPatternLayer, - thisColumnId: string, - changedColumnId: string - ) => C; + onOtherColumnChanged?: (layer: IndexPatternLayer, thisColumnId: string) => C; /** * React component for operation specific settings shown in the flyout editor */ @@ -378,6 +383,17 @@ interface BaseOperationDefinitionProps * Title for the help component */ helpComponentTitle?: string; + /** + * Optimizes EsAggs expression. Invoked only once per operation type. + */ + optimizeEsAggs?: ( + aggs: ExpressionAstExpressionBuilder[], + esAggsIdMap: Record, + aggExpressionToEsAggsIdMap: Map + ) => { + aggs: ExpressionAstExpressionBuilder[]; + esAggsIdMap: Record; + }; } interface BaseBuildColumnArgs { @@ -608,12 +624,11 @@ interface ManagedReferenceOperationDefinition * root level */ createCopy: ( - layer: IndexPatternLayer, - sourceColumnId: string, - targetColumnId: string, - indexPattern: IndexPattern, + layers: Record, + source: DataViewDragDropOperation, + target: DataViewDragDropOperation, operationDefinitionMap: Record - ) => IndexPatternLayer; + ) => Record; } interface OperationDefinitionMap { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx index 55df2b8e0ff1a..10c4310e820b2 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx @@ -108,9 +108,9 @@ function buildMetricOperation>({ (!newField.aggregationRestrictions || newField.aggregationRestrictions![type]) ); }, - onOtherColumnChanged: (layer, thisColumnId, changedColumnId) => + onOtherColumnChanged: (layer, thisColumnId) => optionalTimeScaling - ? (adjustTimeScaleOnOtherColumnChange(layer, thisColumnId, changedColumnId) as T) + ? (adjustTimeScaleOnOtherColumnChange(layer, thisColumnId) as T) : (layer.columns[thisColumnId] as T), getDefaultLabel: (column, indexPattern, columns) => labelLookup(getSafeName(column.sourceField, indexPattern), column), diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx index ae8ba7d965ea7..08afcc447eec6 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.test.tsx @@ -20,6 +20,12 @@ import { percentileOperation } from '.'; import { IndexPattern, IndexPatternLayer } from '../../types'; import { PercentileIndexPatternColumn } from './percentile'; import { TermsIndexPatternColumn } from './terms'; +import { + buildExpressionFunction, + buildExpression, + ExpressionAstExpressionBuilder, +} from '@kbn/expressions-plugin/public'; +import type { OriginalColumn } from '../../to_expression'; jest.mock('lodash', () => { const original = jest.requireActual('lodash'); @@ -187,6 +193,441 @@ describe('percentile', () => { }); }); + describe('optimizeEsAggs', () => { + const makeEsAggBuilder = (name: string, params: object) => + buildExpression({ + type: 'expression', + chain: [buildExpressionFunction(name, params).toAst()], + }); + + const buildMapsFromAggBuilders = (aggs: ExpressionAstExpressionBuilder[]) => { + const esAggsIdMap: Record = {}; + const aggsToIdsMap = new Map(); + aggs.forEach((builder, i) => { + const esAggsId = `col-${i}-${i}`; + esAggsIdMap[esAggsId] = [{ id: `original-${i}` } as OriginalColumn]; + aggsToIdsMap.set(builder, esAggsId); + }); + return { + esAggsIdMap, + aggsToIdsMap, + }; + }; + + it('should collapse percentile dimensions with matching parameters', () => { + const field1 = 'foo'; + const field2 = 'bar'; + const timeShift1 = '1d'; + const timeShift2 = '2d'; + + const aggs = [ + // group 1 + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: field1, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 2, + enabled: true, + schema: 'metric', + field: field1, + percentile: 20, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 3, + enabled: true, + schema: 'metric', + field: field1, + percentile: 30, + timeShift: undefined, + }), + // group 2 + makeEsAggBuilder('aggSinglePercentile', { + id: 4, + enabled: true, + schema: 'metric', + field: field2, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 5, + enabled: true, + schema: 'metric', + field: field2, + percentile: 40, + timeShift: undefined, + }), + // group 3 + makeEsAggBuilder('aggSinglePercentile', { + id: 6, + enabled: true, + schema: 'metric', + field: field2, + percentile: 50, + timeShift: timeShift1, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 7, + enabled: true, + schema: 'metric', + field: field2, + percentile: 60, + timeShift: timeShift1, + }), + // group 4 + makeEsAggBuilder('aggSinglePercentile', { + id: 8, + enabled: true, + schema: 'metric', + field: field2, + percentile: 70, + timeShift: timeShift2, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 9, + enabled: true, + schema: 'metric', + field: field2, + percentile: 80, + timeShift: timeShift2, + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs.length).toBe(4); + + expect(newAggs[0].functions[0].getArgument('field')![0]).toBe(field1); + expect(newAggs[0].functions[0].getArgument('timeShift')).toBeUndefined(); + expect(newAggs[1].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[1].functions[0].getArgument('timeShift')).toBeUndefined(); + expect(newAggs[2].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[2].functions[0].getArgument('timeShift')![0]).toBe(timeShift1); + expect(newAggs[3].functions[0].getArgument('field')![0]).toBe(field2); + expect(newAggs[3].functions[0].getArgument('timeShift')![0]).toBe(timeShift2); + + expect(newAggs).toMatchInlineSnapshot(` + Array [ + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "foo", + ], + "id": Array [ + 1, + ], + "percents": Array [ + 10, + 20, + 30, + ], + "schema": Array [ + "metric", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 4, + ], + "percents": Array [ + 10, + 40, + ], + "schema": Array [ + "metric", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 6, + ], + "percents": Array [ + 50, + 60, + ], + "schema": Array [ + "metric", + ], + "timeShift": Array [ + "1d", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + Object { + "findFunction": [Function], + "functions": Array [ + Object { + "addArgument": [Function], + "arguments": Object { + "enabled": Array [ + true, + ], + "field": Array [ + "bar", + ], + "id": Array [ + 8, + ], + "percents": Array [ + 70, + 80, + ], + "schema": Array [ + "metric", + ], + "timeShift": Array [ + "2d", + ], + }, + "getArgument": [Function], + "name": "aggPercentiles", + "removeArgument": [Function], + "replaceArgument": [Function], + "toAst": [Function], + "toString": [Function], + "type": "expression_function_builder", + }, + ], + "toAst": [Function], + "toString": [Function], + "type": "expression_builder", + }, + ] + `); + + expect(newIdMap).toMatchInlineSnapshot(` + Object { + "col-?-1.10": Array [ + Object { + "id": "original-0", + }, + ], + "col-?-1.20": Array [ + Object { + "id": "original-1", + }, + ], + "col-?-1.30": Array [ + Object { + "id": "original-2", + }, + ], + "col-?-4.10": Array [ + Object { + "id": "original-3", + }, + ], + "col-?-4.40": Array [ + Object { + "id": "original-4", + }, + ], + "col-?-6.50": Array [ + Object { + "id": "original-5", + }, + ], + "col-?-6.60": Array [ + Object { + "id": "original-6", + }, + ], + "col-?-8.70": Array [ + Object { + "id": "original-7", + }, + ], + "col-?-8.80": Array [ + Object { + "id": "original-8", + }, + ], + } + `); + }); + + it('should handle multiple identical percentiles', () => { + const field1 = 'foo'; + const field2 = 'bar'; + const samePercentile = 90; + + const aggs = [ + // group 1 + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 2, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 4, + enabled: true, + schema: 'metric', + field: field2, + percentile: 10, + timeShift: undefined, + }), + makeEsAggBuilder('aggSinglePercentile', { + id: 3, + enabled: true, + schema: 'metric', + field: field1, + percentile: samePercentile, + timeShift: undefined, + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs.length).toBe(2); + expect(newIdMap[`col-?-1.${samePercentile}`].length).toBe(3); + expect(newIdMap).toMatchInlineSnapshot(` + Object { + "col-2-2": Array [ + Object { + "id": "original-2", + }, + ], + "col-?-1.90": Array [ + Object { + "id": "original-0", + }, + Object { + "id": "original-1", + }, + Object { + "id": "original-3", + }, + ], + } + `); + }); + + it("shouldn't touch non-percentile aggs or single percentiles with no siblings", () => { + const aggs = [ + makeEsAggBuilder('aggSinglePercentile', { + id: 1, + enabled: true, + schema: 'metric', + field: 'foo', + percentile: 30, + }), + makeEsAggBuilder('aggMax', { + id: 1, + enabled: true, + schema: 'metric', + field: 'bar', + }), + ]; + + const { esAggsIdMap, aggsToIdsMap } = buildMapsFromAggBuilders(aggs); + + const { esAggsIdMap: newIdMap, aggs: newAggs } = percentileOperation.optimizeEsAggs!( + aggs, + esAggsIdMap, + aggsToIdsMap + ); + + expect(newAggs).toEqual(aggs); + expect(newIdMap).toEqual(esAggsIdMap); + }); + }); + describe('buildColumn', () => { it('should set default percentile', () => { const indexPattern = createMockedIndexPattern(); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx index 0699ad5f88405..a313b03d34e1b 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx @@ -8,8 +8,13 @@ import { EuiFormRow, EuiRange, EuiRangeProps } from '@elastic/eui'; import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; -import { AggFunctionsMapping } from '@kbn/data-plugin/public'; -import { buildExpressionFunction } from '@kbn/expressions-plugin/public'; +import { AggFunctionsMapping, METRIC_TYPES } from '@kbn/data-plugin/public'; +import { + buildExpression, + buildExpressionFunction, + ExpressionAstExpressionBuilder, +} from '@kbn/expressions-plugin/public'; +import { AggExpressionFunctionArgs } from '@kbn/data-plugin/common'; import { OperationDefinition } from '.'; import { getFormatFromPreviousColumn, @@ -143,6 +148,120 @@ export const percentileOperation: OperationDefinition< } ).toAst(); }, + optimizeEsAggs: (_aggs, _esAggsIdMap, aggExpressionToEsAggsIdMap) => { + let aggs = [..._aggs]; + const esAggsIdMap = { ..._esAggsIdMap }; + + const percentileExpressionsByArgs: Record = {}; + + // group percentile dimensions by differentiating parameters + aggs.forEach((expressionBuilder) => { + const { + functions: [fnBuilder], + } = expressionBuilder; + if (fnBuilder.name === 'aggSinglePercentile') { + const groupByKey = `${fnBuilder.getArgument('field')?.[0]}-${ + fnBuilder.getArgument('timeShift')?.[0] + }`; + if (!(groupByKey in percentileExpressionsByArgs)) { + percentileExpressionsByArgs[groupByKey] = []; + } + + percentileExpressionsByArgs[groupByKey].push(expressionBuilder); + } + }); + + // collapse them into a single esAggs expression builder + Object.values(percentileExpressionsByArgs).forEach((expressionBuilders) => { + if (expressionBuilders.length <= 1) { + // don't need to optimize if there aren't more than one + return; + } + + // we're going to merge these percentile builders into a single builder, so + // remove them from the aggs array + aggs = aggs.filter((aggBuilder) => !expressionBuilders.includes(aggBuilder)); + + const { + functions: [firstFnBuilder], + } = expressionBuilders[0]; + + const esAggsColumnId = firstFnBuilder.getArgument('id')![0]; + const aggPercentilesConfig: AggExpressionFunctionArgs = { + id: esAggsColumnId, + enabled: firstFnBuilder.getArgument('enabled')?.[0], + schema: firstFnBuilder.getArgument('schema')?.[0], + field: firstFnBuilder.getArgument('field')?.[0], + percents: [], + // time shift is added to wrapping aggFilteredMetric if filter is set + timeShift: firstFnBuilder.getArgument('timeShift')?.[0], + }; + + const percentileToBuilder: Record = {}; + for (const builder of expressionBuilders) { + const percentile = builder.functions[0].getArgument('percentile')![0] as number; + if (percentile in percentileToBuilder) { + // found a duplicate percentile so let's optimize + + const duplicateExpressionBuilder = percentileToBuilder[percentile]; + + const idForDuplicate = aggExpressionToEsAggsIdMap.get(duplicateExpressionBuilder); + const idForThisOne = aggExpressionToEsAggsIdMap.get(builder); + + if (!idForDuplicate || !idForThisOne) { + throw new Error( + "Couldn't find esAggs ID for percentile expression builder... this should never happen." + ); + } + + esAggsIdMap[idForDuplicate].push(...esAggsIdMap[idForThisOne]); + + delete esAggsIdMap[idForThisOne]; + + // remove current builder + expressionBuilders = expressionBuilders.filter((b) => b !== builder); + } else { + percentileToBuilder[percentile] = builder; + aggPercentilesConfig.percents!.push(percentile); + } + } + + const multiPercentilesAst = buildExpressionFunction( + 'aggPercentiles', + aggPercentilesConfig + ).toAst(); + + aggs.push( + buildExpression({ + type: 'expression', + chain: [multiPercentilesAst], + }) + ); + + expressionBuilders.forEach((expressionBuilder) => { + const currentEsAggsId = aggExpressionToEsAggsIdMap.get(expressionBuilder); + if (currentEsAggsId === undefined) { + throw new Error('Could not find current column ID for percentile agg expression builder'); + } + // esAggs appends the percent number to the agg id to make distinct column IDs in the resulting datatable. + // We're anticipating that here by adding the `.`. + // The agg index will be assigned when we update all the indices in the ID map based on the agg order in the + // datasource's toExpression fn so we mark it as '?' for now. + const newEsAggsId = `col-?-${esAggsColumnId}.${ + expressionBuilder.functions[0].getArgument('percentile')![0] + }`; + + esAggsIdMap[newEsAggsId] = esAggsIdMap[currentEsAggsId]; + + delete esAggsIdMap[currentEsAggsId]; + }); + }); + + return { + esAggsIdMap, + aggs, + }; + }, getErrorMessage: (layer, columnId, indexPattern) => combineErrorMessages([ getInvalidFieldMessage(layer.columns[columnId] as FieldBasedIndexPatternColumn, indexPattern), diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx index 555360a2f7f6c..5642c06c6b642 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/static_value.tsx @@ -16,6 +16,7 @@ import { import type { IndexPattern } from '../../types'; import { useDebouncedValue } from '../../../shared_components'; import { getFormatFromPreviousColumn, isValidNumber } from './helpers'; +import { getColumnOrder } from '../layer_helpers'; const defaultLabel = i18n.translate('xpack.lens.indexPattern.staticValueLabelDefault', { defaultMessage: 'Static value', @@ -132,13 +133,21 @@ export const staticValueOperation: OperationDefinition< isTransferable: (column) => { return true; }, - createCopy(layer, sourceId, targetId, indexPattern, operationDefinitionMap) { - const currentColumn = layer.columns[sourceId] as StaticValueIndexPatternColumn; + createCopy(layers, source, target) { + const currentColumn = layers[source.layerId].columns[ + source.columnId + ] as StaticValueIndexPatternColumn; + const targetLayer = layers[target.layerId]; + const columns = { + ...targetLayer.columns, + [target.columnId]: { ...currentColumn }, + }; return { - ...layer, - columns: { - ...layer.columns, - [targetId]: { ...currentColumn }, + ...layers, + [target.layerId]: { + ...targetLayer, + columns, + columnOrder: getColumnOrder({ ...targetLayer, columns }), }, }; }, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx index 419e087411810..62aed475df42a 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx @@ -325,7 +325,7 @@ export const termsOperation: OperationDefinition { + onOtherColumnChanged: (layer, thisColumnId) => { const columns = layer.columns; const currentColumn = columns[thisColumnId] as TermsIndexPatternColumn; if ( diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx index 1cce6c5b06cd6..99c20bbd8bca6 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/terms.test.tsx @@ -755,8 +755,7 @@ describe('terms', () => { }, }, }, - 'col2', - 'col1' + 'col2' ); expect(updatedColumn).toBe(initialColumn); @@ -796,8 +795,7 @@ describe('terms', () => { columnOrder: [], indexPatternId: '', }, - 'col2', - 'col1' + 'col2' ); expect(updatedColumn.params).toEqual( expect.objectContaining({ @@ -843,8 +841,7 @@ describe('terms', () => { columnOrder: [], indexPatternId: '', }, - 'col2', - 'col1' + 'col2' ); expect(updatedColumn.params).toEqual( expect.objectContaining({ @@ -875,8 +872,7 @@ describe('terms', () => { columnOrder: [], indexPatternId: '', }, - 'col2', - 'col1' + 'col2' ); expect(termsColumn.params).toEqual( expect.objectContaining({ @@ -919,8 +915,7 @@ describe('terms', () => { columnOrder: [], indexPatternId: '', }, - 'col2', - 'col1' + 'col2' ); expect(termsColumn.params).toEqual( expect.objectContaining({ @@ -951,8 +946,7 @@ describe('terms', () => { columnOrder: [], indexPatternId: '', }, - 'col2', - 'col1' + 'col2' ); expect(termsColumn.params).toEqual( expect.objectContaining({ @@ -991,8 +985,7 @@ describe('terms', () => { }, }, }, - 'col2', - 'col1' + 'col2' ); expect(updatedColumn.params).toEqual( diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts index 4fdd82439fc22..ab9319957afca 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.test.ts @@ -159,24 +159,38 @@ describe('state_helpers', () => { params: { window: 5 }, references: ['formulaX0'], }; + expect( copyColumn({ - layer: { - indexPatternId: '', - columnOrder: [], - columns: { - source, - formulaX0: sum, - formulaX1: movingAvg, - formulaX2: math, + layers: { + layer: { + indexPatternId: '', + columnOrder: [], + columns: { + source, + formulaX0: sum, + formulaX1: movingAvg, + formulaX2: math, + }, }, }, - targetId: 'copy', - sourceColumn: source, + source: { + column: source, + groupId: 'one', + columnId: 'source', + layerId: 'layer', + dataView: indexPattern, + filterOperations: () => true, + }, + target: { + columnId: 'copy', + groupId: 'one', + dataView: indexPattern, + layerId: 'layer', + filterOperations: () => true, + }, shouldDeleteSource: false, - indexPattern, - sourceColumnId: 'source', - }) + }).layer ).toEqual({ indexPatternId: '', columnOrder: [ @@ -1355,8 +1369,7 @@ describe('state_helpers', () => { }, incompleteColumns: {}, }, - 'col1', - 'col2' + 'col1' ); }); @@ -1422,8 +1435,7 @@ describe('state_helpers', () => { }, incompleteColumns: {}, }), - 'col1', - 'willBeReference' + 'col1' ); }); @@ -2374,8 +2386,7 @@ describe('state_helpers', () => { expect(operationDefinitionMap.terms.onOtherColumnChanged).toHaveBeenCalledWith( { indexPatternId: '1', columnOrder: ['col1', 'col2'], columns: { col1: termsColumn } }, - 'col1', - 'col2' + 'col1' ); }); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts index 8376a57ddc19d..434370943fbc1 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/layer_helpers.ts @@ -26,6 +26,7 @@ import { TermsIndexPatternColumn, } from './definitions'; import type { + DataViewDragDropOperation, IndexPattern, IndexPatternField, IndexPatternLayer, @@ -68,96 +69,84 @@ interface ColumnChange { } interface ColumnCopy { - layer: IndexPatternLayer; - targetId: string; - sourceColumn: GenericIndexPatternColumn; - sourceColumnId: string; - indexPattern: IndexPattern; + layers: Record; + target: DataViewDragDropOperation; + source: DataViewDragDropOperation; shouldDeleteSource?: boolean; } +export const deleteColumnInLayers = ({ + layers, + source, +}: { + layers: Record; + source: DataViewDragDropOperation; +}) => ({ + ...layers, + [source.layerId]: deleteColumn({ + layer: layers[source.layerId], + columnId: source.columnId, + indexPattern: source.dataView, + }), +}); + export function copyColumn({ - layer, - targetId, - sourceColumn, + layers, + source, + target, shouldDeleteSource, - indexPattern, - sourceColumnId, -}: ColumnCopy): IndexPatternLayer { - let modifiedLayer = copyReferencesRecursively( - layer, - sourceColumn, - sourceColumnId, - targetId, - indexPattern - ); - - if (shouldDeleteSource) { - modifiedLayer = deleteColumn({ - layer: modifiedLayer, - columnId: sourceColumnId, - indexPattern, - }); - } - - return modifiedLayer; +}: ColumnCopy): Record { + const outputLayers = createCopiedColumn(layers, target, source); + return shouldDeleteSource + ? deleteColumnInLayers({ + layers: outputLayers, + source, + }) + : outputLayers; } -function copyReferencesRecursively( - layer: IndexPatternLayer, - sourceColumn: GenericIndexPatternColumn, - sourceId: string, - targetId: string, - indexPattern: IndexPattern -): IndexPatternLayer { - let columns = { ...layer.columns }; +function createCopiedColumn( + layers: Record, + target: DataViewDragDropOperation, + source: DataViewDragDropOperation +): Record { + const sourceLayer = layers[source.layerId]; + const sourceColumn = sourceLayer.columns[source.columnId]; + const targetLayer = layers[target.layerId]; + let columns = { ...targetLayer.columns }; if ('references' in sourceColumn) { - if (columns[targetId]) { - return layer; - } - const def = operationDefinitionMap[sourceColumn.operationType]; if ('createCopy' in def) { - // Allow managed references to recursively insert new columns - return def.createCopy(layer, sourceId, targetId, indexPattern, operationDefinitionMap); + return def.createCopy(layers, source, target, operationDefinitionMap); // Allow managed references to recursively insert new columns } + const referenceColumns = sourceColumn.references.reduce((refs, sourceRef) => { + const newRefId = generateId(); + return { ...refs, [newRefId]: { ...sourceLayer.columns[sourceRef] } }; + }, {}); - sourceColumn?.references.forEach((ref, index) => { - const newId = generateId(); - const refColumn = { ...columns[ref] }; - - // TODO: For fullReference types, now all references are hidden columns, - // but in the future we will have references to visible columns - // and visible columns shouldn't be copied - const refColumnWithInnerRefs = - 'references' in refColumn - ? copyReferencesRecursively(layer, refColumn, sourceId, newId, indexPattern).columns // if a column has references, copy them too - : { [newId]: refColumn }; - - const newColumn = columns[targetId]; - let references = [newId]; - if (newColumn && 'references' in newColumn) { - references = newColumn.references; - references[index] = newId; - } - - columns = { - ...columns, - ...refColumnWithInnerRefs, - [targetId]: { - ...sourceColumn, - references, - }, - }; - }); + columns = { + ...columns, + ...referenceColumns, + [target.columnId]: { + ...sourceColumn, + references: Object.keys(referenceColumns), + }, + }; } else { columns = { ...columns, - [targetId]: sourceColumn, + [target.columnId]: { ...sourceColumn }, }; } - return { ...layer, columns, columnOrder: getColumnOrder({ ...layer, columns }) }; + return { + ...layers, + [target.layerId]: adjustColumnReferences({ + ...targetLayer, + columns, + columnOrder: getColumnOrder({ ...targetLayer, columns }), + }), + }; } export function insertOrReplaceColumn(args: ColumnChange): IndexPatternLayer { @@ -1046,8 +1035,8 @@ function addBucket( } updatedColumnOrder = reorderByGroups( visualizationGroups, - targetGroup, updatedColumnOrder, + targetGroup, addedColumnId ); const tempLayer = { @@ -1064,8 +1053,8 @@ function addBucket( export function reorderByGroups( visualizationGroups: VisualizationDimensionGroupConfig[], - targetGroup: string | undefined, updatedColumnOrder: string[], + targetGroup: string | undefined, addedColumnId: string ) { const hidesColumnGrouping = @@ -1184,6 +1173,26 @@ export function updateColumnParam({ }; } +export function adjustColumnReferences(layer: IndexPatternLayer) { + const newColumns = { ...layer.columns }; + Object.keys(newColumns).forEach((currentColumnId) => { + const currentColumn = newColumns[currentColumnId]; + if (currentColumn?.operationType) { + const operationDefinition = operationDefinitionMap[currentColumn.operationType]; + newColumns[currentColumnId] = operationDefinition.onOtherColumnChanged + ? operationDefinition.onOtherColumnChanged( + { ...layer, columns: newColumns }, + currentColumnId + ) + : currentColumn; + } + }); + return { + ...layer, + columns: newColumns, + }; +} + export function adjustColumnReferencesForChangedColumn( layer: IndexPatternLayer, changedColumnId: string @@ -1196,8 +1205,7 @@ export function adjustColumnReferencesForChangedColumn( newColumns[currentColumnId] = operationDefinition.onOtherColumnChanged ? operationDefinition.onOtherColumnChanged( { ...layer, columns: newColumns }, - currentColumnId, - changedColumnId + currentColumnId ) : currentColumn; } @@ -1561,6 +1569,9 @@ export function isColumnValidAsReference({ if (!column) return false; const operationType = column.operationType; const operationDefinition = operationDefinitionMap[operationType]; + if (!operationDefinition) { + throw new Error('No suitable operation definition found for ' + operationType); + } return ( validation.input.includes(operationDefinition.input) && maybeValidateOperations({ diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts index 1eb02fa82ceef..fd8952ad9e077 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.test.ts @@ -113,11 +113,7 @@ describe('time scale utils', () => { it('should keep column if there is no time scale', () => { const column = { ...baseColumn, timeScale: undefined }; expect( - adjustTimeScaleOnOtherColumnChange( - { ...baseLayer, columns: { col1: column } }, - 'col1', - 'col2' - ) + adjustTimeScaleOnOtherColumnChange({ ...baseLayer, columns: { col1: column } }, 'col1') ).toBe(column); }); @@ -138,14 +134,13 @@ describe('time scale utils', () => { } as DateHistogramIndexPatternColumn, }, }, - 'col1', - 'col2' + 'col1' ) ).toBe(baseColumn); }); it('should remove time scale if there is no date histogram', () => { - expect(adjustTimeScaleOnOtherColumnChange(baseLayer, 'col1', 'col2')).toHaveProperty( + expect(adjustTimeScaleOnOtherColumnChange(baseLayer, 'col1')).toHaveProperty( 'timeScale', undefined ); @@ -153,22 +148,14 @@ describe('time scale utils', () => { it('should remove suffix from label', () => { expect( - adjustTimeScaleOnOtherColumnChange( - { ...baseLayer, columns: { col1: baseColumn } }, - 'col1', - 'col2' - ) + adjustTimeScaleOnOtherColumnChange({ ...baseLayer, columns: { col1: baseColumn } }, 'col1') ).toHaveProperty('label', 'Count of records'); }); it('should keep custom label', () => { const column = { ...baseColumn, label: 'abc', customLabel: true }; expect( - adjustTimeScaleOnOtherColumnChange( - { ...baseLayer, columns: { col1: column } }, - 'col1', - 'col2' - ) + adjustTimeScaleOnOtherColumnChange({ ...baseLayer, columns: { col1: column } }, 'col1') ).toHaveProperty('label', 'abc'); }); }); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts index a8e71c0fd86e5..c6cd343504253 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/time_scale_utils.ts @@ -46,8 +46,7 @@ export function adjustTimeScaleLabelSuffix( export function adjustTimeScaleOnOtherColumnChange( layer: IndexPatternLayer, - thisColumnId: string, - changedColumnId: string + thisColumnId: string ): T { const columns = layer.columns; const column = columns[thisColumnId] as T; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/state_helpers.ts b/x-pack/plugins/lens/public/indexpattern_datasource/state_helpers.ts index 5d48922a66d8a..6e16ebe5e8d53 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/state_helpers.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/state_helpers.ts @@ -24,3 +24,19 @@ export function mergeLayer({ }, }; } + +export function mergeLayers({ + state, + newLayers, +}: { + state: IndexPatternPrivateState; + newLayers: Record; +}) { + return { + ...state, + layers: { + ...state.layers, + ...newLayers, + }, + }; +} diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts index 0307e748ac1fb..6cfab965f36a9 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/to_expression.ts @@ -6,7 +6,7 @@ */ import type { IUiSettingsClient } from '@kbn/core/public'; -import { partition } from 'lodash'; +import { partition, uniq } from 'lodash'; import { AggFunctionsMapping, EsaggsExpressionFunctionDefinition, @@ -27,7 +27,7 @@ import { DateHistogramIndexPatternColumn, RangeIndexPatternColumn } from './oper import { FormattedIndexPatternColumn } from './operations/definitions/column_types'; import { isColumnFormatted, isColumnOfType } from './operations/definitions/helpers'; -type OriginalColumn = { id: string } & GenericIndexPatternColumn; +export type OriginalColumn = { id: string } & GenericIndexPatternColumn; declare global { interface Window { @@ -38,6 +38,15 @@ declare global { } } +// esAggs column ID manipulation functions +const extractEsAggId = (id: string) => id.split('.')[0].split('-')[2]; +const updatePositionIndex = (currentId: string, newIndex: number) => { + const [fullId, percentile] = currentId.split('.'); + const idParts = fullId.split('-'); + idParts[1] = String(newIndex); + return idParts.join('-') + (percentile ? `.${percentile}` : ''); +}; + function getExpressionForLayer( layer: IndexPatternLayer, indexPattern: IndexPattern, @@ -95,7 +104,7 @@ function getExpressionForLayer( ); if (referenceEntries.length || esAggEntries.length) { - const aggs: ExpressionAstExpressionBuilder[] = []; + let aggs: ExpressionAstExpressionBuilder[] = []; const expressions: ExpressionAstFunction[] = []; sortedReferences(referenceEntries).forEach((colId) => { @@ -107,13 +116,17 @@ function getExpressionForLayer( }); const orderedColumnIds = esAggEntries.map(([colId]) => colId); + let esAggsIdMap: Record = {}; + const aggExpressionToEsAggsIdMap: Map = new Map(); esAggEntries.forEach(([colId, col], index) => { const def = operationDefinitionMap[col.operationType]; if (def.input !== 'fullReference' && def.input !== 'managedReference') { + const aggId = String(index); + const wrapInFilter = Boolean(def.filterable && col.filter); let aggAst = def.toEsAggsFn( col, - wrapInFilter ? `${index}-metric` : String(index), + wrapInFilter ? `${aggId}-metric` : aggId, indexPattern, layer, uiSettings, @@ -139,12 +152,25 @@ function getExpressionForLayer( } ).toAst(); } - aggs.push( - buildExpression({ - type: 'expression', - chain: [aggAst], - }) - ); + + const expressionBuilder = buildExpression({ + type: 'expression', + chain: [aggAst], + }); + aggs.push(expressionBuilder); + + const esAggsId = window.ELASTIC_LENS_DELAY_SECONDS + ? `col-${index + (col.isBucketed ? 0 : 1)}-${aggId}` + : `col-${index}-${aggId}`; + + esAggsIdMap[esAggsId] = [ + { + ...col, + id: colId, + }, + ]; + + aggExpressionToEsAggsIdMap.set(expressionBuilder, esAggsId); } }); @@ -164,19 +190,63 @@ function getExpressionForLayer( ); } - const idMap = esAggEntries.reduce((currentIdMap, [colId, column], index) => { - const esAggsId = window.ELASTIC_LENS_DELAY_SECONDS - ? `col-${index + (column.isBucketed ? 0 : 1)}-${index}` - : `col-${index}-${index}`; + uniq(esAggEntries.map(([_, column]) => column.operationType)).forEach((type) => { + const optimizeAggs = operationDefinitionMap[type].optimizeEsAggs?.bind( + operationDefinitionMap[type] + ); + if (optimizeAggs) { + const { aggs: newAggs, esAggsIdMap: newIdMap } = optimizeAggs( + aggs, + esAggsIdMap, + aggExpressionToEsAggsIdMap + ); + + aggs = newAggs; + esAggsIdMap = newIdMap; + } + }); + + /* + Update ID mappings with new agg array positions. + + Given this esAggs-ID-to-original-column map after percentile (for example) optimization: + col-0-0: column1 + col-?-1.34: column2 (34th percentile) + col-2-2: column3 + col-?-1.98: column4 (98th percentile) + + and this array of aggs + 0: { id: 0 } + 1: { id: 2 } + 2: { id: 1 } + + We need to update the anticipated agg indicies to match the aggs array: + col-0-0: column1 + col-2-1.34: column2 (34th percentile) + col-1-2: column3 + col-3-3.98: column4 (98th percentile) + */ + + const updatedEsAggsIdMap: Record = {}; + let counter = 0; + + const esAggsIds = Object.keys(esAggsIdMap); + aggs.forEach((builder) => { + const esAggId = builder.functions[0].getArgument('id')?.[0]; + const matchingEsAggColumnIds = esAggsIds.filter((id) => extractEsAggId(id) === esAggId); + + matchingEsAggColumnIds.forEach((currentId) => { + const currentColumn = esAggsIdMap[currentId][0]; + const aggIndex = window.ELASTIC_LENS_DELAY_SECONDS + ? counter + (currentColumn.isBucketed ? 0 : 1) + : counter; + const newId = updatePositionIndex(currentId, aggIndex); + updatedEsAggsIdMap[newId] = esAggsIdMap[currentId]; + + counter++; + }); + }); - return { - ...currentIdMap, - [esAggsId]: { - ...column, - id: colId, - }, - }; - }, {} as Record); const columnsWithFormatters = columnEntries.filter( ([, col]) => (isColumnOfType('range', col) && col.params?.parentFormat) || @@ -292,9 +362,9 @@ function getExpressionForLayer( }).toAst(), { type: 'function', - function: 'lens_rename_columns', + function: 'lens_map_to_columns', arguments: { - idMap: [JSON.stringify(idMap)], + idMap: [JSON.stringify(updatedEsAggsIdMap)], }, }, ...expressions, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/types.ts b/x-pack/plugins/lens/public/indexpattern_datasource/types.ts index 7e25509c3b2dd..cbf02bddb8814 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/types.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/types.ts @@ -10,6 +10,7 @@ import type { FieldSpec } from '@kbn/data-plugin/common'; import type { FieldFormatParams } from '@kbn/field-formats-plugin/common'; import type { DragDropIdentifier } from '../drag_drop/providers'; import type { IncompleteColumn, GenericIndexPatternColumn } from './operations'; +import { DragDropOperation } from '../types'; export type { GenericIndexPatternColumn, @@ -109,3 +110,8 @@ export interface IndexPatternRef { title: string; name?: string; } + +export interface DataViewDragDropOperation extends DragDropOperation { + dataView: IndexPattern; + column?: GenericIndexPatternColumn; +} diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts index 873159562dc8f..770f4bee7eecd 100644 --- a/x-pack/plugins/lens/public/types.ts +++ b/x-pack/plugins/lens/public/types.ts @@ -199,11 +199,18 @@ interface ChartSettings { }; } -export type GetDropProps = DatasourceDimensionDropProps & { - groupId: string; - dragging: DragContextState['dragging']; - prioritizedOperation?: string; -}; +export interface GetDropPropsArgs { + state: T; + source?: DraggingIdentifier; + target: { + layerId: string; + groupId: string; + columnId: string; + filterOperations: (meta: OperationMetadata) => boolean; + prioritizedOperation?: string; + isNewColumn?: boolean; + }; +} /** * Interface for the datasource registry @@ -257,9 +264,9 @@ export interface Datasource { props: DatasourceLayerPanelProps ) => ((cleanupElement: Element) => void) | void; getDropProps: ( - props: GetDropProps + props: GetDropPropsArgs ) => { dropTypes: DropType[]; nextLabel?: string } | undefined; - onDrop: (props: DatasourceDimensionDropHandlerProps) => false | true | { deleted: string }; + onDrop: (props: DatasourceDimensionDropHandlerProps) => boolean | undefined; /** * The datasource is allowed to cancel a close event on the dimension editor, * mainly used for formulas @@ -454,16 +461,14 @@ export interface DatasourceLayerPanelProps { activeData?: Record; } -export interface DraggedOperation extends DraggingIdentifier { +export interface DragDropOperation { layerId: string; groupId: string; columnId: string; filterOperations: (operation: OperationMetadata) => boolean; } -export function isDraggedOperation( - operationCandidate: unknown -): operationCandidate is DraggedOperation { +export function isOperation(operationCandidate: unknown): operationCandidate is DragDropOperation { return ( typeof operationCandidate === 'object' && operationCandidate !== null && @@ -471,10 +476,8 @@ export function isDraggedOperation( ); } -export type DatasourceDimensionDropProps = SharedDimensionProps & { - layerId: string; - groupId: string; - columnId: string; +export interface DatasourceDimensionDropProps { + target: DragDropOperation; state: T; setState: StateSetter< T, @@ -484,10 +487,10 @@ export type DatasourceDimensionDropProps = SharedDimensionProps & { } >; dimensionGroups: VisualizationDimensionGroupConfig[]; -}; +} -export type DatasourceDimensionDropHandlerProps = DatasourceDimensionDropProps & { - droppedItem: unknown; +export type DatasourceDimensionDropHandlerProps = DatasourceDimensionDropProps & { + source: DragDropIdentifier; dropType: DropType; }; @@ -851,7 +854,17 @@ export interface Visualization { * look at its internal state to determine which dimension is being affected. */ removeDimension: (props: VisualizationDimensionChangeProps) => T; - + /** + * Allow defining custom behavior for the visualization when the drop action occurs. + */ + onDrop?: (props: { + prevState: T; + target: DragDropOperation; + source: DragDropIdentifier; + frame: FramePublicAPI; + dropType: DropType; + group?: VisualizationDimensionGroupConfig; + }) => T; /** * Update the configuration for the visualization. This is used to update the state */ diff --git a/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx b/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx index 35a40623b72aa..692d0f02725b2 100644 --- a/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx @@ -118,6 +118,207 @@ export const getAnnotationsSupportedLayer = ( }; }; +const getDefaultAnnotationConfig = (id: string, timestamp: string): EventAnnotationConfig => ({ + label: defaultAnnotationLabel, + key: { + type: 'point_in_time', + timestamp, + }, + icon: 'triangle', + id, +}); + +const createCopiedAnnotation = ( + newId: string, + timestamp: string, + source?: EventAnnotationConfig +): EventAnnotationConfig => { + if (!source) { + return getDefaultAnnotationConfig(newId, timestamp); + } + return { + ...source, + id: newId, + }; +}; + +export const onAnnotationDrop: Visualization['onDrop'] = ({ + prevState, + frame, + source, + target, + dropType, +}) => { + const targetLayer = prevState.layers.find((l) => l.layerId === target.layerId); + const sourceLayer = prevState.layers.find((l) => l.layerId === source.layerId); + if ( + !targetLayer || + !isAnnotationsLayer(targetLayer) || + !sourceLayer || + !isAnnotationsLayer(sourceLayer) + ) { + return prevState; + } + const targetAnnotation = targetLayer.annotations.find(({ id }) => id === target.columnId); + const sourceAnnotation = sourceLayer.annotations.find(({ id }) => id === source.columnId); + switch (dropType) { + case 'reorder': + if (!targetAnnotation || !sourceAnnotation || source.layerId !== target.layerId) { + return prevState; + } + const newAnnotations = targetLayer.annotations.filter((c) => c.id !== sourceAnnotation.id); + const targetPosition = newAnnotations.findIndex((c) => c.id === targetAnnotation.id); + const targetIndex = targetLayer.annotations.indexOf(sourceAnnotation); + const sourceIndex = targetLayer.annotations.indexOf(targetAnnotation); + newAnnotations.splice( + targetIndex < sourceIndex ? targetPosition + 1 : targetPosition, + 0, + sourceAnnotation + ); + return { + ...prevState, + layers: prevState.layers.map((l) => + l.layerId === target.layerId ? { ...targetLayer, annotations: newAnnotations } : l + ), + }; + case 'swap_compatible': + if (!targetAnnotation || !sourceAnnotation) { + return prevState; + } + return { + ...prevState, + layers: prevState.layers.map((l): XYLayerConfig => { + if (!isAnnotationsLayer(l) || !isAnnotationsLayer(targetLayer)) { + return l; + } + if (l.layerId === target.layerId) { + return { + ...targetLayer, + annotations: [ + ...targetLayer.annotations.map( + (a): EventAnnotationConfig => (a === targetAnnotation ? sourceAnnotation : a) + ), + ], + }; + } + if (l.layerId === source.layerId) { + return { + ...sourceLayer, + annotations: [ + ...sourceLayer.annotations.map( + (a): EventAnnotationConfig => (a === sourceAnnotation ? targetAnnotation : a) + ), + ], + }; + } + return l; + }), + }; + case 'replace_compatible': + if (!targetAnnotation || !sourceAnnotation) { + return prevState; + } + + return { + ...prevState, + layers: prevState.layers.map((l) => { + if (l.layerId === source.layerId) { + return { + ...sourceLayer, + annotations: sourceLayer.annotations.filter((a) => a !== sourceAnnotation), + }; + } + if (l.layerId === target.layerId) { + return { + ...targetLayer, + annotations: [ + ...targetLayer.annotations.map((a) => + a === targetAnnotation ? sourceAnnotation : a + ), + ], + }; + } + return l; + }), + }; + case 'duplicate_compatible': + if (targetAnnotation) { + return prevState; + } + return { + ...prevState, + layers: prevState.layers.map( + (l): XYLayerConfig => + l.layerId === target.layerId + ? { + ...targetLayer, + annotations: [ + ...targetLayer.annotations, + createCopiedAnnotation( + target.columnId, + getStaticDate(getDataLayers(prevState.layers), frame), + sourceAnnotation + ), + ], + } + : l + ), + }; + case 'replace_duplicate_compatible': + if (!targetAnnotation) { + return prevState; + } + return { + ...prevState, + layers: prevState.layers.map((l) => { + if (l.layerId === target.layerId) { + return { + ...targetLayer, + annotations: [ + ...targetLayer.annotations.map((a) => + a === targetAnnotation + ? createCopiedAnnotation( + target.columnId, + getStaticDate(getDataLayers(prevState.layers), frame), + sourceAnnotation + ) + : a + ), + ], + }; + } + return l; + }), + }; + case 'move_compatible': + if (targetAnnotation || !sourceAnnotation) { + return prevState; + } + + return { + ...prevState, + layers: prevState.layers.map((l): XYLayerConfig => { + if (l.layerId === source.layerId) { + return { + ...sourceLayer, + annotations: sourceLayer.annotations.filter((a) => a !== sourceAnnotation), + }; + } + if (l.layerId === target.layerId) { + return { + ...targetLayer, + annotations: [...targetLayer.annotations, sourceAnnotation], + }; + } + return l; + }), + }; + default: + return prevState; + } + return prevState; +}; + export const setAnnotationsDimension: Visualization['setDimension'] = ({ prevState, layerId, @@ -125,46 +326,30 @@ export const setAnnotationsDimension: Visualization['setDimension'] = ( previousColumn, frame, }) => { - const foundLayer = prevState.layers.find((l) => l.layerId === layerId); - if (!foundLayer || !isAnnotationsLayer(foundLayer)) { + const targetLayer = prevState.layers.find((l) => l.layerId === layerId); + if (!targetLayer || !isAnnotationsLayer(targetLayer)) { return prevState; } - const inputAnnotations = foundLayer.annotations as XYAnnotationLayerConfig['annotations']; - const currentConfig = inputAnnotations?.find(({ id }) => id === columnId); - const previousConfig = previousColumn - ? inputAnnotations?.find(({ id }) => id === previousColumn) + const sourceAnnotation = previousColumn + ? targetLayer.annotations?.find(({ id }) => id === previousColumn) : undefined; - let resultAnnotations = [...inputAnnotations] as XYAnnotationLayerConfig['annotations']; - - if (!currentConfig) { - resultAnnotations.push({ - label: defaultAnnotationLabel, - key: { - type: 'point_in_time', - timestamp: getStaticDate(getDataLayers(prevState.layers), frame), - }, - icon: 'triangle', - ...previousConfig, - id: columnId, - }); - } else if (currentConfig && previousConfig) { - // TODO: reordering should not live in setDimension, to be refactored - resultAnnotations = inputAnnotations.filter((c) => c.id !== previousConfig.id); - const targetPosition = resultAnnotations.findIndex((c) => c.id === currentConfig.id); - const targetIndex = inputAnnotations.indexOf(previousConfig); - const sourceIndex = inputAnnotations.indexOf(currentConfig); - resultAnnotations.splice( - targetIndex < sourceIndex ? targetPosition + 1 : targetPosition, - 0, - previousConfig - ); - } - return { ...prevState, layers: prevState.layers.map((l) => - l.layerId === layerId ? { ...foundLayer, annotations: resultAnnotations } : l + l.layerId === layerId + ? { + ...targetLayer, + annotations: [ + ...targetLayer.annotations, + createCopiedAnnotation( + columnId, + getStaticDate(getDataLayers(prevState.layers), frame), + sourceAnnotation + ), + ], + } + : l ), }; }; @@ -224,7 +409,6 @@ export const getAnnotationsConfiguration = ({ defaultMessage: 'Annotations require a time based chart to work. Add a date histogram.', }), required: false, - requiresPreviousColumnOnDuplicate: true, supportsMoreColumns: true, supportFieldFormat: false, enableDimensionEditor: true, diff --git a/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx b/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx index 3f0e8816cf6b1..ece9a6d28893e 100644 --- a/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx @@ -18,6 +18,7 @@ import { checkScaleOperation, getAxisName, getDataLayers, + getReferenceLayers, isNumericMetric, isReferenceLayer, } from './visualization_helpers'; @@ -342,7 +343,10 @@ export const setReferenceDimension: Visualization['setDimension'] = ({ newLayer.accessors = [...newLayer.accessors.filter((a) => a !== columnId), columnId]; const hasYConfig = newLayer.yConfig?.some(({ forAccessor }) => forAccessor === columnId); const previousYConfig = previousColumn - ? newLayer.yConfig?.find(({ forAccessor }) => forAccessor === previousColumn) + ? getReferenceLayers(prevState.layers) + .map(({ yConfig }) => yConfig) + .flat() + ?.find((yConfig) => yConfig?.forAccessor === previousColumn) : false; if (!hasYConfig) { const axisMode: YAxisMode = diff --git a/x-pack/plugins/lens/public/xy_visualization/visualization.test.ts b/x-pack/plugins/lens/public/xy_visualization/visualization.test.ts index 1cc3df6b5ca96..0092bb78a6d71 100644 --- a/x-pack/plugins/lens/public/xy_visualization/visualization.test.ts +++ b/x-pack/plugins/lens/public/xy_visualization/visualization.test.ts @@ -476,7 +476,7 @@ describe('xy_visualization', () => { }); it('should copy previous column if passed and assign a new id', () => { expect( - xyVisualization.setDimension({ + xyVisualization.onDrop!({ frame, prevState: { ...exampleState(), @@ -488,10 +488,20 @@ describe('xy_visualization', () => { }, ], }, - layerId: 'annotation', - groupId: 'xAnnotation', - previousColumn: 'an2', - columnId: 'newColId', + dropType: 'duplicate_compatible', + source: { + layerId: 'annotation', + groupId: 'xAnnotation', + columnId: 'an2', + id: 'an2', + humanData: { label: 'an2' }, + }, + target: { + layerId: 'annotation', + groupId: 'xAnnotation', + columnId: 'newColId', + filterOperations: Boolean, + }, }).layers[0] ).toEqual({ layerId: 'annotation', @@ -501,7 +511,7 @@ describe('xy_visualization', () => { }); it('should reorder a dimension to a annotation layer', () => { expect( - xyVisualization.setDimension({ + xyVisualization.onDrop!({ frame, prevState: { ...exampleState(), @@ -513,10 +523,21 @@ describe('xy_visualization', () => { }, ], }, - layerId: 'annotation', - groupId: 'xAnnotation', - previousColumn: 'an2', - columnId: 'an1', + source: { + layerId: 'annotation', + groupId: 'xAnnotation', + columnId: 'an2', + id: 'an2', + humanData: { label: 'label' }, + filterOperations: () => true, + }, + target: { + layerId: 'annotation', + groupId: 'xAnnotation', + columnId: 'an1', + filterOperations: () => true, + }, + dropType: 'reorder', }).layers[0] ).toEqual({ layerId: 'annotation', @@ -524,6 +545,199 @@ describe('xy_visualization', () => { annotations: [exampleAnnotation2, exampleAnnotation], }); }); + + it('should duplicate the annotations and replace the target in another annotation layer', () => { + expect( + xyVisualization.onDrop!({ + frame, + prevState: { + ...exampleState(), + layers: [ + { + layerId: 'first', + layerType: 'annotations', + annotations: [exampleAnnotation], + }, + { + layerId: 'second', + layerType: 'annotations', + annotations: [exampleAnnotation2], + }, + ], + }, + source: { + layerId: 'first', + groupId: 'xAnnotation', + columnId: 'an1', + id: 'an1', + humanData: { label: 'label' }, + filterOperations: () => true, + }, + target: { + layerId: 'second', + groupId: 'xAnnotation', + columnId: 'an2', + filterOperations: () => true, + }, + dropType: 'replace_duplicate_compatible', + }).layers + ).toEqual([ + { + layerId: 'first', + layerType: layerTypes.ANNOTATIONS, + annotations: [exampleAnnotation], + }, + { + layerId: 'second', + layerType: layerTypes.ANNOTATIONS, + annotations: [{ ...exampleAnnotation, id: 'an2' }], + }, + ]); + }); + it('should swap the annotations between layers', () => { + expect( + xyVisualization.onDrop!({ + frame, + prevState: { + ...exampleState(), + layers: [ + { + layerId: 'first', + layerType: 'annotations', + annotations: [exampleAnnotation], + }, + { + layerId: 'second', + layerType: 'annotations', + annotations: [exampleAnnotation2], + }, + ], + }, + source: { + layerId: 'first', + groupId: 'xAnnotation', + columnId: 'an1', + id: 'an1', + humanData: { label: 'label' }, + filterOperations: () => true, + }, + target: { + layerId: 'second', + groupId: 'xAnnotation', + columnId: 'an2', + filterOperations: () => true, + }, + dropType: 'swap_compatible', + }).layers + ).toEqual([ + { + layerId: 'first', + layerType: layerTypes.ANNOTATIONS, + annotations: [exampleAnnotation2], + }, + { + layerId: 'second', + layerType: layerTypes.ANNOTATIONS, + annotations: [exampleAnnotation], + }, + ]); + }); + it('should replace the target in another annotation layer', () => { + expect( + xyVisualization.onDrop!({ + frame, + prevState: { + ...exampleState(), + layers: [ + { + layerId: 'first', + layerType: 'annotations', + annotations: [exampleAnnotation], + }, + { + layerId: 'second', + layerType: 'annotations', + annotations: [exampleAnnotation2], + }, + ], + }, + source: { + layerId: 'first', + groupId: 'xAnnotation', + columnId: 'an1', + id: 'an1', + humanData: { label: 'label' }, + filterOperations: () => true, + }, + target: { + layerId: 'second', + groupId: 'xAnnotation', + columnId: 'an2', + filterOperations: () => true, + }, + dropType: 'replace_compatible', + }).layers + ).toEqual([ + { + layerId: 'first', + layerType: layerTypes.ANNOTATIONS, + annotations: [], + }, + { + layerId: 'second', + layerType: layerTypes.ANNOTATIONS, + annotations: [exampleAnnotation], + }, + ]); + }); + it('should move compatible to another annotation layer', () => { + expect( + xyVisualization.onDrop!({ + frame, + prevState: { + ...exampleState(), + layers: [ + { + layerId: 'first', + layerType: 'annotations', + annotations: [exampleAnnotation], + }, + { + layerId: 'second', + layerType: 'annotations', + annotations: [], + }, + ], + }, + source: { + layerId: 'first', + groupId: 'xAnnotation', + columnId: 'an1', + id: 'an1', + humanData: { label: 'label' }, + filterOperations: () => true, + }, + target: { + layerId: 'second', + groupId: 'xAnnotation', + columnId: 'an2', + filterOperations: () => true, + }, + dropType: 'move_compatible', + }).layers + ).toEqual([ + { + layerId: 'first', + layerType: layerTypes.ANNOTATIONS, + annotations: [], + }, + { + layerId: 'second', + layerType: layerTypes.ANNOTATIONS, + annotations: [exampleAnnotation], + }, + ]); + }); }); }); diff --git a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx index 4f89ba1fdcedf..dcf3ab3e42a47 100644 --- a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx @@ -27,7 +27,7 @@ import { getSuggestions } from './xy_suggestions'; import { XyToolbar } from './xy_config_panel'; import { DimensionEditor } from './xy_config_panel/dimension_editor'; import { LayerHeader } from './xy_config_panel/layer_header'; -import type { Visualization, AccessorConfig, FramePublicAPI } from '../types'; +import { Visualization, AccessorConfig, FramePublicAPI } from '../types'; import { State, visualizationTypes, XYSuggestion, XYLayerConfig, XYDataLayerConfig } from './types'; import { layerTypes } from '../../common'; import { isHorizontalChart } from './state_helpers'; @@ -45,6 +45,7 @@ import { getAnnotationsSupportedLayer, setAnnotationsDimension, getUniqueLabels, + onAnnotationDrop, } from './annotations/helpers'; import { checkXAccessorCompatibility, @@ -71,6 +72,7 @@ import { ReferenceLinePanel } from './xy_config_panel/reference_line_config_pane import { AnnotationsPanel } from './xy_config_panel/annotations_config_panel'; import { DimensionTrigger } from '../shared_components/dimension_trigger'; import { defaultAnnotationLabel } from './annotations/helpers'; +import { onDropForVisualization } from '../editor_frame_service/editor_frame/config_panel/buttons/drop_targets_utils'; export const getXyVisualization = ({ datatableUtilities, @@ -303,6 +305,20 @@ export const getXyVisualization = ({ return getFirstDataLayer(state.layers)?.palette; }, + onDrop(props) { + const targetLayer: XYLayerConfig | undefined = props.prevState.layers.find( + (l) => l.layerId === props.target.layerId + ); + if (!targetLayer) { + throw new Error('target layer should exist'); + } + + if (isAnnotationsLayer(targetLayer)) { + return onAnnotationDrop?.(props) || props.prevState; + } + return onDropForVisualization(props, this); + }, + setDimension(props) { const { prevState, layerId, columnId, groupId } = props; diff --git a/x-pack/plugins/lens/public/xy_visualization/visualization_helpers.tsx b/x-pack/plugins/lens/public/xy_visualization/visualization_helpers.tsx index d390d081258a5..9b4ed872f1dc2 100644 --- a/x-pack/plugins/lens/public/xy_visualization/visualization_helpers.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/visualization_helpers.tsx @@ -334,6 +334,7 @@ export function validateLayersForDimension( export const isNumericMetric = (op: OperationMetadata) => !op.isBucketed && op.dataType === 'number'; + export const isNumericDynamicMetric = (op: OperationMetadata) => isNumericMetric(op) && !op.isStaticValue; export const isBucketed = (op: OperationMetadata) => op.isBucketed; diff --git a/x-pack/plugins/lens/server/expressions/expressions.ts b/x-pack/plugins/lens/server/expressions/expressions.ts index bd516c756df15..1e80fc5bb49a3 100644 --- a/x-pack/plugins/lens/server/expressions/expressions.ts +++ b/x-pack/plugins/lens/server/expressions/expressions.ts @@ -10,7 +10,7 @@ import type { ExpressionsServerSetup } from '@kbn/expressions-plugin/server'; import { counterRate, formatColumn, - renameColumns, + mapToColumns, getTimeScale, getDatatable, } from '../../common/expressions'; @@ -25,7 +25,7 @@ export const setupExpressions = ( [ counterRate, formatColumn, - renameColumns, + mapToColumns, getDatatable(getFormatFactory(core)), getTimeScale(getDatatableUtilitiesFactory(core), getTimeZoneFactory(core)), ].forEach((expressionFn) => expressions.registerFunction(expressionFn)); diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap index 069bcc103ebae..44da5a61e5876 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/add_license.test.js.snap @@ -1,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`AddLicense component when license is active should display correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; +exports[`AddLicense component when license is active should display correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; -exports[`AddLicense component when license is expired should display with correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; +exports[`AddLicense component when license is expired should display with correct verbiage 1`] = `"
Update your license

If you already have a new license, upload it now.

Update license
"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/license_page_header.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/license_page_header.test.js.snap index 1c1fd4602f491..d68f2cb0f3100 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/license_page_header.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/license_page_header.test.js.snap @@ -1,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`LicenseStatus component should display display warning is expired 1`] = `"

Your Platinum license has expired

Your license expired on

"`; +exports[`LicenseStatus component should display display warning is expired 1`] = `"

Your Platinum license has expired

Your license expired on

"`; -exports[`LicenseStatus component should display normally when license is active 1`] = `"

Your Gold license is active

Your license will expire on October 12, 2099 7:00 PM EST

"`; +exports[`LicenseStatus component should display normally when license is active 1`] = `"

Your Gold license is active

Your license will expire on October 12, 2099 7:00 PM EST

"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap index f7d34d99e46bf..36aed262fa692 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/request_trial_extension.test.js.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`RequestTrialExtension component should display when enterprise license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when enterprise license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when license is active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when license is active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; -exports[`RequestTrialExtension component should display when platinum license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; +exports[`RequestTrialExtension component should display when platinum license is not active and trial has been used 1`] = `"
Extend your trial

If you’d like to continue using machine learning, advanced security, and our other awesome subscription featuresExternal link(opens in a new tab or window), request an extension now.

Extend trial
"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap index a392e4712cb5a..5662a73be4d00 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/revert_to_basic.test.js.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`RevertToBasic component should display when license is about to expire 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when license is about to expire 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; -exports[`RevertToBasic component should display when license is expired 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when license is expired 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; -exports[`RevertToBasic component should display when trial is active 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; +exports[`RevertToBasic component should display when trial is active 1`] = `"
Revert to Basic license

You’ll revert to our free features and lose access to machine learning, advanced security, and other subscription featuresExternal link(opens in a new tab or window).

"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap index 52f1597fd1aca..dc49f993eb533 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/start_trial.test.js.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`StartTrial component when trial is allowed display for basic license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed display for basic license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for expired enterprise license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for expired enterprise license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for expired platinum license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for expired platinum license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; -exports[`StartTrial component when trial is allowed should display for gold license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; +exports[`StartTrial component when trial is allowed should display for gold license 1`] = `"
Start a 30-day trial

Experience what machine learning, advanced security, and all our other subscription featuresExternal link(opens in a new tab or window) have to offer.

"`; diff --git a/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap b/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap index 301585a0ab914..63445516b6eb2 100644 --- a/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap +++ b/x-pack/plugins/license_management/__jest__/__snapshots__/upload_license.test.tsx.snap @@ -2,7 +2,7 @@ exports[`UploadLicense should display a modal when license requires acknowledgement 1`] = `

Your license key is a JSON file with a signature attached. @@ -119,7 +119,7 @@ exports[`UploadLicense should display a modal when license requires acknowledgem exports[`UploadLicense should display an error when ES says license is expired 1`] = `

Your license key is a JSON file with a signature attached. @@ -153,7 +153,7 @@ exports[`UploadLicense should display an error when ES says license is expired 1 >

Your license key is a JSON file with a signature attached. @@ -297,7 +293,7 @@ exports[`UploadLicense should display an error when ES says license is invalid 1 >

Your license key is a JSON file with a signature attached. @@ -441,7 +433,7 @@ exports[`UploadLicense should display an error when submitting invalid JSON 1`] >

Your license key is a JSON file with a signature attached. @@ -585,7 +573,7 @@ exports[`UploadLicense should display error when ES returns error 1`] = ` >

{interpolateTitle} -

+

{percentilesTitle} -

+

- - + -

- +
{ // extract properties of the error object from within the response error diff --git a/x-pack/plugins/ml/common/util/group_color_utils.ts b/x-pack/plugins/ml/common/util/group_color_utils.ts index b9709671475be..3c2398a18684f 100644 --- a/x-pack/plugins/ml/common/util/group_color_utils.ts +++ b/x-pack/plugins/ml/common/util/group_color_utils.ts @@ -7,7 +7,7 @@ import { euiDarkVars as euiVars } from '@kbn/ui-theme'; -import { stringHash } from './string_utils'; +import { stringHash } from '@kbn/ml-string-hash'; const COLORS = [ euiVars.euiColorVis0, diff --git a/x-pack/plugins/ml/common/util/job_utils.ts b/x-pack/plugins/ml/common/util/job_utils.ts index f1991118d4e36..d7faf732a7c84 100644 --- a/x-pack/plugins/ml/common/util/job_utils.ts +++ b/x-pack/plugins/ml/common/util/job_utils.ts @@ -9,9 +9,9 @@ import { each, isEmpty, isEqual, pick } from 'lodash'; import semverGte from 'semver/functions/gte'; import moment, { Duration } from 'moment'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -// @ts-ignore import numeral from '@elastic/numeral'; import { i18n } from '@kbn/i18n'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { ALLOWED_DATA_UNITS, JOB_ID_MAX_LENGTH } from '../constants/validation'; import { parseInterval } from './parse_interval'; import { maxLengthValidator } from './validators'; @@ -24,7 +24,7 @@ import { ES_AGGREGATION, ML_JOB_AGGREGATION } from '../constants/aggregation_typ import { MLCATEGORY } from '../constants/field_types'; import { getAggregations, getDatafeedAggregations } from './datafeed_utils'; import { findAggField } from './validation_utils'; -import { getFirstKeyInObject, isPopulatedObject } from './object_utils'; +import { getFirstKeyInObject } from './object_utils'; import { isDefined } from '../types/guards'; export interface ValidationResults { diff --git a/x-pack/plugins/ml/common/util/object_utils.test.ts b/x-pack/plugins/ml/common/util/object_utils.test.ts index d6d500cdb82c6..e6a0617c6335e 100644 --- a/x-pack/plugins/ml/common/util/object_utils.test.ts +++ b/x-pack/plugins/ml/common/util/object_utils.test.ts @@ -5,49 +5,9 @@ * 2.0. */ -import { getFirstKeyInObject, isPopulatedObject } from './object_utils'; +import { getFirstKeyInObject } from './object_utils'; describe('object_utils', () => { - describe('isPopulatedObject()', () => { - it('does not allow numbers', () => { - expect(isPopulatedObject(0)).toBe(false); - }); - it('does not allow strings', () => { - expect(isPopulatedObject('')).toBe(false); - }); - it('does not allow null', () => { - expect(isPopulatedObject(null)).toBe(false); - }); - it('does not allow an empty object', () => { - expect(isPopulatedObject({})).toBe(false); - }); - it('allows an object with an attribute', () => { - expect(isPopulatedObject({ attribute: 'value' })).toBe(true); - }); - it('does not allow an object with a non-existing required attribute', () => { - expect(isPopulatedObject({ attribute: 'value' }, ['otherAttribute'])).toBe(false); - }); - it('allows an object with an existing required attribute', () => { - expect(isPopulatedObject({ attribute: 'value' }, ['attribute'])).toBe(true); - }); - it('allows an object with two existing required attributes', () => { - expect( - isPopulatedObject({ attribute1: 'value1', attribute2: 'value2' }, [ - 'attribute1', - 'attribute2', - ]) - ).toBe(true); - }); - it('does not allow an object with two required attributes where one does not exist', () => { - expect( - isPopulatedObject({ attribute1: 'value1', attribute2: 'value2' }, [ - 'attribute1', - 'otherAttribute', - ]) - ).toBe(false); - }); - }); - describe('getFirstKeyInObject()', () => { it('gets the first key in object', () => { expect(getFirstKeyInObject({ attribute1: 'value', attribute2: 'value2' })).toBe('attribute1'); diff --git a/x-pack/plugins/ml/common/util/object_utils.ts b/x-pack/plugins/ml/common/util/object_utils.ts index cd62ca006725e..2bf2e301f9473 100644 --- a/x-pack/plugins/ml/common/util/object_utils.ts +++ b/x-pack/plugins/ml/common/util/object_utils.ts @@ -5,35 +5,7 @@ * 2.0. */ -/* - * A type guard to check record like object structures. - * - * Examples: - * - `isPopulatedObject({...})` - * Limits type to Record - * - * - `isPopulatedObject({...}, ['attribute'])` - * Limits type to Record<'attribute', unknown> - * - * - `isPopulatedObject({...})` - * Limits type to a record with keys of the given interface. - * Note that you might want to add keys from the interface to the - * array of requiredAttributes to satisfy runtime requirements. - * Otherwise you'd just satisfy TS requirements but might still - * run into runtime issues. - */ -export const isPopulatedObject = ( - arg: unknown, - requiredAttributes: U[] = [] -): arg is Record => { - return ( - typeof arg === 'object' && - arg !== null && - Object.keys(arg).length > 0 && - (requiredAttributes.length === 0 || - requiredAttributes.every((d) => ({}.hasOwnProperty.call(arg, d)))) - ); -}; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; /** * Get the first key in the object diff --git a/x-pack/plugins/ml/common/util/query_utils.ts b/x-pack/plugins/ml/common/util/query_utils.ts index 22c0f45f2f239..5ceda44fa44b3 100644 --- a/x-pack/plugins/ml/common/util/query_utils.ts +++ b/x-pack/plugins/ml/common/util/query_utils.ts @@ -7,7 +7,7 @@ import { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; import { cloneDeep } from 'lodash'; -import { isPopulatedObject } from './object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export const addExcludeFrozenToQuery = (originalQuery: QueryDslQueryContainer | undefined) => { const FROZEN_TIER_TERM = { diff --git a/x-pack/plugins/ml/common/util/runtime_field_utils.ts b/x-pack/plugins/ml/common/util/runtime_field_utils.ts index 6b2cb78d73274..10179d5e51732 100644 --- a/x-pack/plugins/ml/common/util/runtime_field_utils.ts +++ b/x-pack/plugins/ml/common/util/runtime_field_utils.ts @@ -6,7 +6,7 @@ */ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { RUNTIME_FIELD_TYPES } from '@kbn/data-plugin/common'; -import { isPopulatedObject } from './object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; type RuntimeType = typeof RUNTIME_FIELD_TYPES[number]; diff --git a/x-pack/plugins/ml/common/util/string_utils.test.ts b/x-pack/plugins/ml/common/util/string_utils.test.ts index 52a3c10da8b5a..43acc80110001 100644 --- a/x-pack/plugins/ml/common/util/string_utils.test.ts +++ b/x-pack/plugins/ml/common/util/string_utils.test.ts @@ -5,12 +5,7 @@ * 2.0. */ -import { - renderTemplate, - getMedianStringLength, - stringHash, - getGroupQueryText, -} from './string_utils'; +import { renderTemplate, getMedianStringLength, getGroupQueryText } from './string_utils'; const strings: string[] = [ 'foo', @@ -53,14 +48,6 @@ describe('ML - string utils', () => { }); }); - describe('stringHash', () => { - test('should return a unique number based off a string', () => { - const hash1 = stringHash('the-string-1'); - const hash2 = stringHash('the-string-2'); - expect(hash1).not.toBe(hash2); - }); - }); - describe('getGroupQueryText', () => { const groupIdOne = 'test_group_id_1'; const groupIdTwo = 'test_group_id_2'; diff --git a/x-pack/plugins/ml/common/util/string_utils.ts b/x-pack/plugins/ml/common/util/string_utils.ts index 044b34d166a87..d55d007ceb225 100644 --- a/x-pack/plugins/ml/common/util/string_utils.ts +++ b/x-pack/plugins/ml/common/util/string_utils.ts @@ -24,23 +24,6 @@ export function getMedianStringLength(strings: string[]) { return sortedStringLengths[Math.floor(sortedStringLengths.length / 2)] || 0; } -/** - * Creates a deterministic number based hash out of a string. - */ -export function stringHash(str: string): number { - let hash = 0; - let chr = 0; - if (str.length === 0) { - return hash; - } - for (let i = 0; i < str.length; i++) { - chr = str.charCodeAt(i); - hash = (hash << 5) - hash + chr; // eslint-disable-line no-bitwise - hash |= 0; // eslint-disable-line no-bitwise - } - return hash < 0 ? hash * -2 : hash; -} - export function getGroupQueryText(groupIds: string[]): string { return `groups:(${groupIds.join(' or ')})`; } diff --git a/x-pack/plugins/ml/common/util/validators.ts b/x-pack/plugins/ml/common/util/validators.ts index 0936efbcb00fc..b28e120b1f196 100644 --- a/x-pack/plugins/ml/common/util/validators.ts +++ b/x-pack/plugins/ml/common/util/validators.ts @@ -5,9 +5,9 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { ALLOWED_DATA_UNITS } from '../constants/validation'; import { parseInterval } from './parse_interval'; -import { isPopulatedObject } from './object_utils'; /** * Provides a validator function for maximum allowed input length. diff --git a/x-pack/plugins/ml/public/alerting/jobs_health_rule/anomaly_detection_jobs_health_rule_trigger.tsx b/x-pack/plugins/ml/public/alerting/jobs_health_rule/anomaly_detection_jobs_health_rule_trigger.tsx index dcbf580461e0f..1b88b38788554 100644 --- a/x-pack/plugins/ml/public/alerting/jobs_health_rule/anomaly_detection_jobs_health_rule_trigger.tsx +++ b/x-pack/plugins/ml/public/alerting/jobs_health_rule/anomaly_detection_jobs_health_rule_trigger.tsx @@ -11,13 +11,13 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import useDebounce from 'react-use/lib/useDebounce'; import { RuleTypeParamsExpressionProps } from '@kbn/triggers-actions-ui-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { MlAnomalyDetectionJobsHealthRuleParams } from '../../../common/types/alerts'; import { JobSelectorControl } from '../job_selector'; import { jobsApiProvider } from '../../application/services/ml_api_service/jobs'; import { HttpService } from '../../application/services/http_service'; import { useMlKibana } from '../../application/contexts/kibana'; import { TestsSelectionControl } from './tests_selection_control'; -import { isPopulatedObject } from '../../../common'; import { ALL_JOBS_SELECTION } from '../../../common/constants/alerts'; import { BetaBadge } from '../beta_badge'; import { isDefined } from '../../../common/types/guards'; diff --git a/x-pack/plugins/ml/public/application/components/controls/select_severity/select_severity.tsx b/x-pack/plugins/ml/public/application/components/controls/select_severity/select_severity.tsx index 4a386c7524478..444ff0f0ab9ec 100644 --- a/x-pack/plugins/ml/public/application/components/controls/select_severity/select_severity.tsx +++ b/x-pack/plugins/ml/public/application/components/controls/select_severity/select_severity.tsx @@ -102,7 +102,7 @@ export const getSeverityOptions = () => -

+

= ({ <> {s.snapshot_id} -

{s.description}

+

{s.description}

 ), diff --git a/x-pack/plugins/ml/public/application/components/scatterplot_matrix/scatterplot_matrix.tsx b/x-pack/plugins/ml/public/application/components/scatterplot_matrix/scatterplot_matrix.tsx index b93ba79830f98..e11de5fea47d3 100644 --- a/x-pack/plugins/ml/public/application/components/scatterplot_matrix/scatterplot_matrix.tsx +++ b/x-pack/plugins/ml/public/application/components/scatterplot_matrix/scatterplot_matrix.tsx @@ -25,9 +25,9 @@ import { import { i18n } from '@kbn/i18n'; import { DataView } from '@kbn/data-views-plugin/public'; +import { stringHash } from '@kbn/ml-string-hash'; import { extractErrorMessage } from '../../../../common'; import { isRuntimeMappings } from '../../../../common/util/runtime_field_utils'; -import { stringHash } from '../../../../common/util/string_utils'; import { RuntimeMappings } from '../../../../common/types/fields'; import type { ResultsSearchQuery } from '../../data_frame_analytics/common/analytics'; import { getCombinedRuntimeMappings } from '../data_grid'; diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/runtime_mappings/runtime_mappings.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/runtime_mappings/runtime_mappings.tsx index 9de32fdd5bd3e..962a06410ca50 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/runtime_mappings/runtime_mappings.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/runtime_mappings/runtime_mappings.tsx @@ -21,10 +21,10 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { XJsonMode } from '@kbn/ace'; import { XJson } from '@kbn/es-ui-shared-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { useMlContext } from '../../../../../contexts/ml'; import { CreateAnalyticsFormProps } from '../../../analytics_management/hooks/use_create_analytics_form'; import { getCombinedRuntimeMappings } from '../../../../../components/data_grid/common'; -import { isPopulatedObject } from '../../../../../../../common/util/object_utils'; import { RuntimeMappingsEditor } from './runtime_mappings_editor'; import { isRuntimeMappings } from '../../../../../../../common'; import { SwitchModal } from './switch_modal'; diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/hooks/use_exploration_url_state.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/hooks/use_exploration_url_state.ts index dac1a85211c20..1a26cce465d85 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/hooks/use_exploration_url_state.ts +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/hooks/use_exploration_url_state.ts @@ -5,11 +5,11 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { usePageUrlState } from '../../../../util/url_state'; import { ML_PAGES } from '../../../../../../common/constants/locator'; import { ExplorationPageUrlState } from '../../../../../../common/types/locator'; import { SEARCH_QUERY_LANGUAGE } from '../../../../../../common/constants/search'; -import { isPopulatedObject } from '../../../../../../common/util/object_utils'; export function getDefaultExplorationPageUrlState( overrides?: Partial diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/job_map/components/cytoscape_options.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/job_map/components/cytoscape_options.tsx index b7dc4d617427d..d8c61de0a510c 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/job_map/components/cytoscape_options.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/job_map/components/cytoscape_options.tsx @@ -95,8 +95,7 @@ export const getCytoscapeOptions = (theme: EuiThemeType): cytoscape.CytoscapeOpt // @ts-ignore 'background-image': (el: cytoscape.NodeSingular) => iconForNode(el), 'border-width': (el: cytoscape.NodeSingular) => (el.selected() ? 4 : 3), - // @ts-ignore - color: theme.euiTextColors.default, + color: theme.euiTextColor, 'font-family': 'Inter UI, Segoe UI, Helvetica, Arial, sans-serif', 'font-size': theme.euiFontSizeXS, 'min-zoomed-font-size': parseInt(theme.euiSizeL, 10), @@ -104,9 +103,9 @@ export const getCytoscapeOptions = (theme: EuiThemeType): cytoscape.CytoscapeOpt shape: (el: cytoscape.NodeSingular) => shapeForNode(el, theme), 'text-background-color': theme.euiColorLightestShade, 'text-background-opacity': 0, - 'text-background-padding': theme.paddingSizes.xs, + 'text-background-padding': theme.euiSizeXS, 'text-background-shape': 'roundrectangle', - 'text-margin-y': parseInt(theme.paddingSizes.s, 10), + 'text-margin-y': parseInt(theme.euiSizeS, 10), 'text-max-width': '200px', 'text-valign': 'bottom', 'text-wrap': 'wrap', @@ -123,7 +122,7 @@ export const getCytoscapeOptions = (theme: EuiThemeType): cytoscape.CytoscapeOpt 'target-arrow-color': lineColor, 'target-arrow-shape': 'triangle', // @ts-ignore - 'target-distance-from-node': theme.paddingSizes.xs, + 'target-distance-from-node': theme.euiSizeXS, width: 1, 'source-arrow-shape': 'none', }, diff --git a/x-pack/plugins/ml/public/application/jobs/jobs_list/components/datafeed_chart_flyout/datafeed_chart_flyout.tsx b/x-pack/plugins/ml/public/application/jobs/jobs_list/components/datafeed_chart_flyout/datafeed_chart_flyout.tsx index d14bc0943a988..cce322156af3a 100644 --- a/x-pack/plugins/ml/public/application/jobs/jobs_list/components/datafeed_chart_flyout/datafeed_chart_flyout.tsx +++ b/x-pack/plugins/ml/public/application/jobs/jobs_list/components/datafeed_chart_flyout/datafeed_chart_flyout.tsx @@ -42,11 +42,17 @@ import { ScaleType, Settings, timeFormatter, + RectAnnotationEvent, + LineAnnotationEvent, } from '@elastic/charts'; import { DATAFEED_STATE } from '../../../../../../common/constants/states'; -import { CombinedJobWithStats } from '../../../../../../common/types/anomaly_detection_jobs'; +import { + CombinedJobWithStats, + ModelSnapshot, +} from '../../../../../../common/types/anomaly_detection_jobs'; import { JobMessage } from '../../../../../../common/types/audit_message'; +import { LineAnnotationDatumWithModelSnapshot } from '../../../../../../common/types/results'; import { useToastNotificationService } from '../../../../services/toast_notification_service'; import { useMlApiContext } from '../../../../contexts/kibana'; import { useCurrentEuiTheme } from '../../../../components/color_range_legend'; @@ -58,14 +64,23 @@ import { checkPermission } from '../../../../capabilities/check_capabilities'; const dateFormatter = timeFormatter('MM-DD HH:mm:ss'); const MAX_CHART_POINTS = 480; +const revertSnapshotMessage = i18n.translate( + 'xpack.ml.jobsList.datafeedChart.revertSnapshotMessage', + { + defaultMessage: 'Click to revert to this model snapshot.', + } +); interface DatafeedChartFlyoutProps { jobId: string; end: number; onClose: () => void; + onModelSnapshotAnnotationClick: (modelSnapshot: ModelSnapshot) => void; } -function setLineAnnotationHeader(lineDatum: LineAnnotationDatum) { +function setLineAnnotationHeader( + lineDatum: LineAnnotationDatum | LineAnnotationDatumWithModelSnapshot +) { lineDatum.header = dateFormatter(lineDatum.dataValue); return lineDatum; } @@ -78,12 +93,23 @@ const customTooltip: CustomAnnotationTooltip = ({ details, datum }) => (
); -export const DatafeedChartFlyout: FC = ({ jobId, end, onClose }) => { +export const DatafeedChartFlyout: FC = ({ + jobId, + end, + onClose, + onModelSnapshotAnnotationClick, +}) => { const [data, setData] = useState<{ datafeedConfig: CombinedJobWithStats['datafeed_config'] | undefined; bucketSpan: string | undefined; isInitialized: boolean; - }>({ datafeedConfig: undefined, bucketSpan: undefined, isInitialized: false }); + modelSnapshotData: LineAnnotationDatumWithModelSnapshot[]; + }>({ + datafeedConfig: undefined, + bucketSpan: undefined, + isInitialized: false, + modelSnapshotData: [], + }); const [endDate, setEndDate] = useState(moment(end)); const [isLoadingChartData, setIsLoadingChartData] = useState(false); const [bucketData, setBucketData] = useState([]); @@ -91,15 +117,20 @@ export const DatafeedChartFlyout: FC = ({ jobId, end, rect: RectAnnotationDatum[]; line: LineAnnotationDatum[]; }>({ rect: [], line: [] }); - const [modelSnapshotData, setModelSnapshotData] = useState([]); + const [modelSnapshotDataForTimeRange, setModelSnapshotDataForTimeRange] = useState< + LineAnnotationDatumWithModelSnapshot[] + >([]); const [messageData, setMessageData] = useState([]); const [sourceData, setSourceData] = useState([]); const [showAnnotations, setShowAnnotations] = useState(true); const [showModelSnapshots, setShowModelSnapshots] = useState(true); const [range, setRange] = useState<{ start: string; end: string } | undefined>(); const canUpdateDatafeed = useMemo(() => checkPermission('canUpdateDatafeed'), []); + const canCreateJob = useMemo(() => checkPermission('canCreateJob'), []); + const canStartStopDatafeed = useMemo(() => checkPermission('canStartStopDatafeed'), []); const { + getModelSnapshots, results: { getDatafeedResultChartData }, } = useMlApiContext(); const { displayErrorToast } = useToastNotificationService(); @@ -144,7 +175,11 @@ export const DatafeedChartFlyout: FC = ({ jobId, end, rect: chartData.annotationResultsRect, line: chartData.annotationResultsLine.map(setLineAnnotationHeader), }); - setModelSnapshotData(chartData.modelSnapshotResultsLine.map(setLineAnnotationHeader)); + setModelSnapshotDataForTimeRange( + data.modelSnapshotData.filter( + (datum) => datum.dataValue >= startTimestamp && datum.dataValue <= endTimestamp + ) + ); } catch (error) { const title = i18n.translate('xpack.ml.jobsList.datafeedChart.errorToastTitle', { defaultMessage: 'Error fetching data', @@ -154,21 +189,37 @@ export const DatafeedChartFlyout: FC = ({ jobId, end, setIsLoadingChartData(false); }, [endDate, data.bucketSpan]); - const getJobData = useCallback(async () => { + const getJobAndSnapshotData = useCallback(async () => { try { const job: CombinedJobWithStats = await loadFullJob(jobId); + const modelSnapshotResultsLine: LineAnnotationDatumWithModelSnapshot[] = []; + const modelSnapshotsResp = await getModelSnapshots(jobId); + const modelSnapshots = modelSnapshotsResp.model_snapshots ?? []; + modelSnapshots.forEach((modelSnapshot) => { + const timestamp = Number(modelSnapshot.latest_record_time_stamp); + + modelSnapshotResultsLine.push({ + dataValue: timestamp, + details: `${modelSnapshot.description}. ${ + canCreateJob && canStartStopDatafeed ? revertSnapshotMessage : '' + }`, + modelSnapshot, + }); + }); + setData({ datafeedConfig: job.datafeed_config, bucketSpan: job.analysis_config.bucket_span, isInitialized: true, + modelSnapshotData: modelSnapshotResultsLine.map(setLineAnnotationHeader), }); } catch (error) { displayErrorToast(error); } }, [jobId]); - useEffect(function loadJobWithDatafeed() { - getJobData(); + useEffect(function loadInitialData() { + getJobAndSnapshotData(); }, []); useEffect( @@ -323,6 +374,24 @@ export const DatafeedChartFlyout: FC = ({ jobId, end, { + // If it's not a line annotation or if it's not a model snapshot annotation then do nothing + if ( + !(canCreateJob && canStartStopDatafeed) || + annotations.lines?.length === 0 || + (annotations.lines && + !annotations.lines[0].id.includes('Model snapshots')) + ) + return; + + onModelSnapshotAnnotationClick( + // @ts-expect-error property 'modelSnapshot' does not exist on type + annotations.lines[0].datum.modelSnapshot + ); + }} // TODO use the EUI charts theme see src/plugins/charts/public/services/theme/README.md theme={{ lineSeriesStyle: { @@ -349,28 +418,6 @@ export const DatafeedChartFlyout: FC = ({ jobId, end, })} position={Position.Left} /> - {showModelSnapshots ? ( - } - markerPosition={Position.Top} - style={{ - line: { - strokeWidth: 3, - stroke: euiTheme.euiColorVis1, - opacity: 0.5, - }, - }} - /> - ) : null} {showAnnotations ? ( <> = ({ jobId, end, /> ) : null} + {showModelSnapshots ? ( + } + markerPosition={Position.Top} + style={{ + line: { + strokeWidth: 3, + stroke: euiTheme.euiColorVis1, + opacity: 0.5, + }, + }} + /> + ) : null} {messageData.length > 0 ? ( <> this.updateJob(j)); @@ -151,10 +154,31 @@ export class JobDetailsUI extends Component { datafeedChartFlyoutVisible: false, }); }} + onModelSnapshotAnnotationClick={(modelSnapshot) => { + this.setState({ + modelSnapshot, + revertSnapshotFlyoutVisible: true, + datafeedChartFlyoutVisible: false, + }); + }} end={job.data_counts.latest_bucket_timestamp} jobId={this.props.jobId} /> ) : null} + {this.state.revertSnapshotFlyoutVisible === true && + this.state.modelSnapshot !== null ? ( + { + this.setState({ + revertSnapshotFlyoutVisible: false, + }); + }} + refresh={refreshJobList} + /> + ) : null} ), }, diff --git a/x-pack/plugins/ml/public/application/jobs/jobs_list/components/utils.js b/x-pack/plugins/ml/public/application/jobs/jobs_list/components/utils.js index d6926950dce7d..364cdd1be55db 100644 --- a/x-pack/plugins/ml/public/application/jobs/jobs_list/components/utils.js +++ b/x-pack/plugins/ml/public/application/jobs/jobs_list/components/utils.js @@ -21,7 +21,7 @@ import { JOB_STATE, DATAFEED_STATE } from '../../../../../common/constants/state import { JOB_ACTION } from '../../../../../common/constants/job_actions'; import { parseInterval } from '../../../../../common/util/parse_interval'; import { mlCalendarService } from '../../../services/calendar_service'; -import { isPopulatedObject } from '../../../../../common/util/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export function loadFullJob(jobId) { return new Promise((resolve, reject) => { diff --git a/x-pack/plugins/ml/public/application/jobs/jobs_utils.ts b/x-pack/plugins/ml/public/application/jobs/jobs_utils.ts index 103f079b88ff3..79952312723fa 100644 --- a/x-pack/plugins/ml/public/application/jobs/jobs_utils.ts +++ b/x-pack/plugins/ml/public/application/jobs/jobs_utils.ts @@ -6,7 +6,7 @@ */ import { MlJob } from '@elastic/elasticsearch/lib/api/types'; -import { isPopulatedObject } from '../../../common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { MlSummaryJob } from '../../../common/types/anomaly_detection_jobs'; export const isManagedJob = (job: MlSummaryJob | MlJob) => { diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/filter_runtime_mappings.ts b/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/filter_runtime_mappings.ts index 9f6f301891741..2f081369ca686 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/filter_runtime_mappings.ts +++ b/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/filter_runtime_mappings.ts @@ -5,9 +5,9 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { RuntimeMappings } from '../../../../../../../common/types/fields'; import type { Datafeed, Job } from '../../../../../../../common/types/anomaly_detection_jobs'; -import { isPopulatedObject } from '../../../../../../../common/util/object_utils'; interface Response { runtime_mappings: RuntimeMappings; diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/recognize/page.tsx b/x-pack/plugins/ml/public/application/jobs/new_job/recognize/page.tsx index c370778b178c8..59176d06d92c0 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/recognize/page.tsx +++ b/x-pack/plugins/ml/public/application/jobs/new_job/recognize/page.tsx @@ -19,6 +19,7 @@ import { } from '@elastic/eui'; import { merge } from 'lodash'; import moment from 'moment'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { useMlKibana, useMlLocator } from '../../../contexts/kibana'; import { ml } from '../../../services/ml_api_service'; import { useMlContext } from '../../../contexts/ml'; @@ -40,7 +41,6 @@ import { JobId } from '../../../../../common/types/anomaly_detection_jobs'; import { ML_PAGES } from '../../../../../common/constants/locator'; import { TIME_FORMAT } from '../../../../../common/constants/time_format'; import { JobsAwaitingNodeWarning } from '../../../components/jobs_awaiting_node_warning'; -import { isPopulatedObject } from '../../../../../common/util/object_utils'; import { RuntimeMappings } from '../../../../../common/types/fields'; import { addExcludeFrozenToQuery } from '../../../../../common/util/query_utils'; import { MlPageHeader } from '../../../components/page_header'; diff --git a/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts b/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts index 0ed3b511b669e..d1e42dd72ddaf 100644 --- a/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts +++ b/x-pack/plugins/ml/public/application/services/anomaly_explorer_charts_service.ts @@ -9,12 +9,12 @@ import { Observable, of } from 'rxjs'; import { map as mapObservable } from 'rxjs/operators'; import type { TimeRange } from '@kbn/es-query'; import type { TimefilterContract } from '@kbn/data-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { RecordForInfluencer } from './results_service/results_service'; import type { EntityField } from '../../../common/util/anomaly_utils'; import type { CombinedJob } from '../../../common/types/anomaly_detection_jobs'; import type { MlApiServices } from './ml_api_service'; import type { MlResultsService } from './results_service'; -import { isPopulatedObject } from '../../../common/util/object_utils'; import { ExplorerChartsData } from '../explorer/explorer_charts/explorer_charts_container_service'; import type { TimeRangeBounds } from '../util/time_buckets'; import { isDefined } from '../../../common/types/guards'; diff --git a/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts b/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts index cbe4017a02835..38bf80be1ffed 100644 --- a/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts +++ b/x-pack/plugins/ml/public/application/services/anomaly_timeline_service.ts @@ -8,6 +8,7 @@ import { IUiSettingsClient } from '@kbn/core/public'; import type { TimeRange } from '@kbn/es-query'; import { TimefilterContract, UI_SETTINGS } from '@kbn/data-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { getBoundsRoundedToInterval, TimeBuckets, @@ -24,7 +25,6 @@ import { OVERALL_LABEL, VIEW_BY_JOB_LABEL } from '../explorer/explorer_constants import { MlResultsService } from './results_service'; import { EntityField } from '../../../common/util/anomaly_utils'; import { InfluencersFilterQuery } from '../../../common/types/es_client'; -import { isPopulatedObject } from '../../../common'; /** * Service for retrieving anomaly swim lanes data. diff --git a/x-pack/plugins/ml/public/application/services/ml_api_service/trained_models.ts b/x-pack/plugins/ml/public/application/services/ml_api_service/trained_models.ts index d15c500ddb9c4..201ed34e42654 100644 --- a/x-pack/plugins/ml/public/application/services/ml_api_service/trained_models.ts +++ b/x-pack/plugins/ml/public/application/services/ml_api_service/trained_models.ts @@ -48,7 +48,7 @@ export interface InferenceStatsResponse { } export interface MlInferTrainedModelDeploymentResponse { - inference_results: estypes.MlInferTrainedModelDeploymentResponse[]; + inference_results: estypes.MlInferenceResponseResult[]; } /** diff --git a/x-pack/plugins/ml/public/application/services/results_service/result_service_rx.ts b/x-pack/plugins/ml/public/application/services/results_service/result_service_rx.ts index 54dece80f22cf..d5da658755943 100644 --- a/x-pack/plugins/ml/public/application/services/results_service/result_service_rx.ts +++ b/x-pack/plugins/ml/public/application/services/results_service/result_service_rx.ts @@ -15,6 +15,7 @@ import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; import { each, get } from 'lodash'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { Dictionary } from '../../../../common/types/common'; import { ML_MEDIAN_PERCENTS } from '../../../../common/util/job_utils'; import { Datafeed, JobId } from '../../../../common/types/anomaly_detection_jobs'; @@ -24,7 +25,6 @@ import { findAggField } from '../../../../common/util/validation_utils'; import { getDatafeedAggregations } from '../../../../common/util/datafeed_utils'; import { aggregationTypeTransform, EntityField } from '../../../../common/util/anomaly_utils'; import { ES_AGGREGATION } from '../../../../common/constants/aggregation_types'; -import { isPopulatedObject } from '../../../../common/util/object_utils'; import { InfluencersFilterQuery } from '../../../../common/types/es_client'; import { RecordForInfluencer } from './results_service'; import { isRuntimeMappings } from '../../../../common'; diff --git a/x-pack/plugins/ml/public/application/services/results_service/results_service.js b/x-pack/plugins/ml/public/application/services/results_service/results_service.js index bb6f6b5969ac4..b26e52f5f32f2 100644 --- a/x-pack/plugins/ml/public/application/services/results_service/results_service.js +++ b/x-pack/plugins/ml/public/application/services/results_service/results_service.js @@ -7,6 +7,8 @@ import { each, get } from 'lodash'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; + import { ML_MEDIAN_PERCENTS } from '../../../../common/util/job_utils'; import { escapeForElasticsearchQuery } from '../../util/string_utils'; import { @@ -14,7 +16,6 @@ import { SWIM_LANE_DEFAULT_PAGE_SIZE, } from '../../explorer/explorer_constants'; import { aggregationTypeTransform } from '../../../../common/util/anomaly_utils'; -import { isPopulatedObject } from '../../../../common/util/object_utils'; /** * Service for carrying out Elasticsearch queries to obtain data for the Ml Results dashboards. diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/expanded_row.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/expanded_row.tsx index 8b868a088499d..6ab9261213d56 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/expanded_row.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/expanded_row.tsx @@ -23,9 +23,9 @@ import { import type { EuiDescriptionListProps } from '@elastic/eui/src/components/description_list/description_list'; import { FormattedMessage } from '@kbn/i18n-react'; import { FIELD_FORMAT_IDS } from '@kbn/field-formats-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { ModelItemFull } from './models_list'; import { isDefined } from '../../../../common/types/guards'; -import { isPopulatedObject } from '../../../../common'; import { ModelPipelines } from './pipelines'; import { AllocatedModels } from '../nodes_overview/allocated_models'; import type { AllocatedModel } from '../../../../common/types/trained_models'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx index 4f3cef2eeda12..07b1e876d4120 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx @@ -26,6 +26,7 @@ import { EuiBasicTableColumn } from '@elastic/eui/src/components/basic_table/bas import { EuiTableSelectionType } from '@elastic/eui/src/components/basic_table/table_types'; import { Action } from '@elastic/eui/src/components/basic_table/action_types'; import { FIELD_FORMAT_IDS } from '@kbn/field-formats-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { getAnalysisType } from '../../data_frame_analytics/common'; import { ModelsTableToConfigMapping } from '.'; import { ModelsBarStats, StatsBar } from '../../components/stats_bar'; @@ -44,7 +45,6 @@ import { ML_PAGES } from '../../../../common/constants/locator'; import { ListingPageUrlState } from '../../../../common/types/common'; import { usePageUrlState } from '../../util/url_state'; import { ExpandedRow } from './expanded_row'; -import { isPopulatedObject } from '../../../../common'; import { useTableSettings } from '../../data_frame_analytics/pages/analytics_management/components/analytics_list/use_table_settings'; import { useToastNotificationService } from '../../services/toast_notification_service'; import { useFieldFormatter } from '../../contexts/kibana/use_field_formatter'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts index e3b502a10f6ce..ed1d8fdacbca4 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts @@ -74,17 +74,17 @@ export abstract class InferenceBase { protected abstract infer(): Promise; - protected getInferenceConfig(): estypes.AggregationsClassificationInferenceOptions | undefined { + protected getInferenceConfig(): estypes.MlInferenceConfigCreateContainer[keyof estypes.MlInferenceConfigCreateContainer] { return this.model.inference_config[ - this.inferenceType as keyof estypes.AggregationsInferenceConfigContainer + this.inferenceType as keyof estypes.MlInferenceConfigCreateContainer ]; } protected getNumTopClassesConfig(defaultOverride = 5) { - const options: estypes.AggregationsClassificationInferenceOptions | undefined = + const options: estypes.MlInferenceConfigCreateContainer[keyof estypes.MlInferenceConfigCreateContainer] = this.getInferenceConfig(); - if (options?.num_top_classes !== undefined && options?.num_top_classes > 0) { + if (options && 'num_top_classes' in options && (options?.num_top_classes ?? 0 > 0)) { return {}; } diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts index ab136900c7d1e..6592e44800d14 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts @@ -39,9 +39,7 @@ export function processResponse( const { inference_results: [inferenceResults], } = resp; - const labels: string[] = - // @ts-expect-error inference config is wrong - model.inference_config.text_classification?.classification_labels ?? []; + const labels: string[] = model.inference_config.text_classification?.classification_labels ?? []; let formattedResponse = [ { diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/utils.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/utils.ts index 3ac6ec77f576a..e340170ce46ce 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/utils.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/utils.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { TRAINED_MODEL_TYPE, DEPLOYMENT_STATE, @@ -13,8 +14,6 @@ import { import type { SupportedPytorchTasksType } from '../../../../../common/constants/trained_models'; import type { ModelItem } from '../models_list'; -import { isPopulatedObject } from '../../../../../common'; - const PYTORCH_TYPES = Object.values(SUPPORTED_PYTORCH_TASKS); export function isTestable(modelItem: ModelItem) { diff --git a/x-pack/plugins/ml/public/application/util/url_state.tsx b/x-pack/plugins/ml/public/application/util/url_state.tsx index 42d5c012b9c14..a31b574681827 100644 --- a/x-pack/plugins/ml/public/application/util/url_state.tsx +++ b/x-pack/plugins/ml/public/application/util/url_state.tsx @@ -21,11 +21,11 @@ import { useHistory, useLocation } from 'react-router-dom'; import { BehaviorSubject, Observable } from 'rxjs'; import { distinctUntilChanged } from 'rxjs/operators'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { Dictionary } from '../../../common/types/common'; import { getNestedProperty } from './object_utils'; import { MlPages } from '../../../common/constants/locator'; -import { isPopulatedObject } from '../../../common'; type Accessor = '_a' | '_g'; export type SetUrlState = ( diff --git a/x-pack/plugins/ml/public/embeddables/types.ts b/x-pack/plugins/ml/public/embeddables/types.ts index 2ba4af15f7466..6a990db33398a 100644 --- a/x-pack/plugins/ml/public/embeddables/types.ts +++ b/x-pack/plugins/ml/public/embeddables/types.ts @@ -10,6 +10,7 @@ import type { Filter, Query, TimeRange } from '@kbn/es-query'; import type { RefreshInterval } from '@kbn/data-plugin/common'; import type { EmbeddableInput, EmbeddableOutput, IEmbeddable } from '@kbn/embeddable-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { JobId } from '../../common/types/anomaly_detection_jobs'; import type { SwimlaneType } from '../application/explorer/explorer_constants'; import type { AnomalyDetectorService } from '../application/services/anomaly_detector_service'; @@ -18,7 +19,6 @@ import type { MlDependencies } from '../application/app'; import type { AppStateSelectedCells } from '../application/explorer/explorer_utils'; import { AnomalyExplorerChartsService } from '../application/services/anomaly_explorer_charts_service'; import { EntityField } from '../../common/util/anomaly_utils'; -import { isPopulatedObject } from '../../common/util/object_utils'; import { ANOMALY_EXPLORER_CHARTS_EMBEDDABLE_TYPE, ANOMALY_SWIMLANE_EMBEDDABLE_TYPE, diff --git a/x-pack/plugins/ml/server/lib/ml_client/ml_client.ts b/x-pack/plugins/ml/server/lib/ml_client/ml_client.ts index 808c77d4d6ea5..a54bad9d886fe 100644 --- a/x-pack/plugins/ml/server/lib/ml_client/ml_client.ts +++ b/x-pack/plugins/ml/server/lib/ml_client/ml_client.ts @@ -494,7 +494,7 @@ export function getMlClient( await modelIdsCheck(p); return mlClient.stopTrainedModelDeployment(...p); }, - async inferTrainedModelDeployment(...p: Parameters) { + async inferTrainedModel(...p: Parameters) { await modelIdsCheck(p); // Temporary workaround for the incorrect inferTrainedModelDeployment function in the esclient if ( diff --git a/x-pack/plugins/ml/server/lib/query_utils.test.ts b/x-pack/plugins/ml/server/lib/query_utils.test.ts index a83265ed1262f..c505a8a9b1fa8 100644 --- a/x-pack/plugins/ml/server/lib/query_utils.test.ts +++ b/x-pack/plugins/ml/server/lib/query_utils.test.ts @@ -5,11 +5,7 @@ * 2.0. */ -import { - buildBaseFilterCriteria, - buildSamplerAggregation, - getSamplerAggregationsResponsePath, -} from './query_utils'; +import { buildBaseFilterCriteria } from './query_utils'; describe('ML - query utils', () => { describe('buildBaseFilterCriteria', () => { @@ -52,37 +48,4 @@ describe('ML - query utils', () => { ]); }); }); - - describe('buildSamplerAggregation', () => { - const testAggs = { - bytes_stats: { - stats: { field: 'bytes' }, - }, - }; - - test('returns wrapped sampler aggregation for sampler shard size of 1000', () => { - expect(buildSamplerAggregation(testAggs, 1000)).toEqual({ - sample: { - sampler: { - shard_size: 1000, - }, - aggs: testAggs, - }, - }); - }); - - test('returns un-sampled aggregation as-is for sampler shard size of 0', () => { - expect(buildSamplerAggregation(testAggs, 0)).toEqual(testAggs); - }); - }); - - describe('getSamplerAggregationsResponsePath', () => { - test('returns correct path for sampler shard size of 1000', () => { - expect(getSamplerAggregationsResponsePath(1000)).toEqual(['sample']); - }); - - test('returns correct path for sampler shard size of 0', () => { - expect(getSamplerAggregationsResponsePath(0)).toEqual([]); - }); - }); }); diff --git a/x-pack/plugins/ml/server/lib/query_utils.ts b/x-pack/plugins/ml/server/lib/query_utils.ts index cfaa5abaf7f23..a60622583781b 100644 --- a/x-pack/plugins/ml/server/lib/query_utils.ts +++ b/x-pack/plugins/ml/server/lib/query_utils.ts @@ -5,7 +5,6 @@ * 2.0. */ -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; /* * Contains utility functions for building and processing queries. */ @@ -37,32 +36,3 @@ export function buildBaseFilterCriteria( return filterCriteria; } - -// Wraps the supplied aggregations in a sampler aggregation. -// A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) -// of less than 1 indicates no sampling, and the aggs are returned as-is. -export function buildSamplerAggregation( - aggs: any, - samplerShardSize: number -): Record { - if (samplerShardSize < 1) { - return aggs; - } - - return { - sample: { - sampler: { - shard_size: samplerShardSize, - }, - aggs, - }, - }; -} - -// Returns the path of aggregations in the elasticsearch response, as an array, -// depending on whether sampling is being used. -// A supplied samplerShardSize (the shard_size parameter of the sampler aggregation) -// of less than 1 indicates no sampling, and an empty array is returned. -export function getSamplerAggregationsResponsePath(samplerShardSize: number): string[] { - return samplerShardSize > 0 ? ['sample'] : []; -} diff --git a/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_manager.ts b/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_manager.ts index d4076a7cf496a..d841777215eae 100644 --- a/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_manager.ts +++ b/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_manager.ts @@ -6,18 +6,17 @@ */ import Boom from '@hapi/boom'; +import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { IScopedClusterClient } from '@kbn/core/server'; import { INDEX_CREATED_BY, JOB_MAP_NODE_TYPES, JobMapNodeTypes, } from '../../../common/constants/data_frame_analytics'; -import { TrainedModelConfigResponse } from '../../../common/types/trained_models'; import { AnalyticsMapEdgeElement, AnalyticsMapReturnType, AnalyticsMapNodeElement, - DataFrameAnalyticsStats, MapElements, } from '../../../common/types/data_frame_analytics'; import { getAnalysisType } from '../../../common/util/analytics_utils'; @@ -36,53 +35,18 @@ import { import type { MlClient } from '../../lib/ml_client'; export class AnalyticsManager { - private _client: IScopedClusterClient; - private _mlClient: MlClient; - private _inferenceModels: TrainedModelConfigResponse[]; - private _jobStats: DataFrameAnalyticsStats[]; - - constructor(mlClient: MlClient, client: IScopedClusterClient) { - this._client = client; - this._mlClient = mlClient; - this._inferenceModels = []; - this._jobStats = []; - } - - public set jobStats(stats) { - this._jobStats = stats; - } - - public get jobStats() { - return this._jobStats; - } - - public set inferenceModels(models) { - this._inferenceModels = models; - } - - public get inferenceModels() { - return this._inferenceModels; - } - - async setInferenceModels() { - try { - const models = await this.getAnalyticsModels(); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete - this.inferenceModels = models; - } catch (error) { - // eslint-disable-next-line - console.error('Unable to fetch inference models', error); - } - } - - async setJobStats() { - try { - const jobStats = await this.getAnalyticsStats(); - this.jobStats = jobStats; - } catch (error) { - // eslint-disable-next-line - console.error('Unable to fetch job stats', error); - } + private _trainedModels: estypes.MlTrainedModelConfig[] = []; + private _jobs: estypes.MlDataframeAnalyticsSummary[] = []; + + constructor(private _mlClient: MlClient, private _client: IScopedClusterClient) {} + + private async initData() { + const [models, jobs] = await Promise.all([ + this._mlClient.getTrainedModels(), + this._mlClient.getDataFrameAnalytics({ size: 1000 }), + ]); + this._trainedModels = models.trained_model_configs; + this._jobs = jobs.data_frame_analytics; } private isDuplicateElement(analyticsId: string, elements: MapElements[]): boolean { @@ -99,50 +63,6 @@ export class AnalyticsManager { return isDuplicate; } - private async getAnalyticsModelData(modelId: string) { - const resp = await this._mlClient.getTrainedModels({ - model_id: modelId, - }); - const modelData = resp?.trained_model_configs[0]; - return modelData; - } - - private async getAnalyticsModels() { - const resp = await this._mlClient.getTrainedModels(); - const models = resp?.trained_model_configs; - return models; - } - - private async getAnalyticsStats() { - const resp = await this._mlClient.getDataFrameAnalyticsStats({ size: 1000 }); - const stats = resp?.data_frame_analytics; - return stats; - } - - private async getAnalyticsData(analyticsId?: string) { - const options = analyticsId - ? { - id: analyticsId, - } - : undefined; - const resp = await this._mlClient.getDataFrameAnalytics(options); - let jobData = analyticsId ? resp?.data_frame_analytics[0] : resp?.data_frame_analytics; - - if (analyticsId !== undefined) { - const jobStats = this.findJobStats(analyticsId); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete - jobData = { ...jobData, stats: { ...jobStats } }; - } else { - // @ts-expect-error @elastic-elasticsearch Data frame types incompletes - jobData = jobData.map((job: any) => { - const jobStats = this.findJobStats(job.id); - return { ...job, stats: { ...jobStats } }; - }); - } - - return jobData; - } - private async getIndexData(index: string) { const indexData = await this._client.asInternalUser.indices.get({ index, @@ -158,14 +78,30 @@ export class AnalyticsManager { return transformData; } - private findJobModel(analyticsId: string): any { - return this.inferenceModels.find( - (model) => model.metadata?.analytics_config?.id === analyticsId + private findJobModel(analyticsId: string, analyticsCreateTime: number): any { + return this._trainedModels.find( + (model) => + // @ts-expect-error @elastic-elasticsearch Data frame types incomplete + model.metadata?.analytics_config?.id === analyticsId && + // @ts-expect-error @elastic-elasticsearch Data frame types incomplete + model.metadata?.analytics_config.create_time === analyticsCreateTime ); } - private findJobStats(analyticsId: string): DataFrameAnalyticsStats | undefined { - return this.jobStats.find((js) => js.id === analyticsId); + private findJob(id: string): estypes.MlDataframeAnalyticsSummary { + const job = this._jobs.find((js) => js.id === id); + if (job === undefined) { + throw Error(`No known job with id '${id}'`); + } + return job; + } + + private findTrainedModel(id: string): estypes.MlTrainedModelConfig { + const trainedModel = this._trainedModels.find((js) => js.model_id === id); + if (trainedModel === undefined) { + throw Error(`No known trained model with id '${id}'`); + } + return trainedModel; } private async getNextLink({ @@ -188,7 +124,7 @@ export class AnalyticsManager { return { isWildcardIndexPattern, isIndexPattern: true, indexData, meta }; } else if (type.includes(JOB_MAP_NODE_TYPES.ANALYTICS)) { // fetch job associated with this index - const jobData = await this.getAnalyticsData(id); + const jobData = this.findJob(id); return { jobData, isJob: true }; } else if (type === JOB_MAP_NODE_TYPES.TRANSFORM) { // fetch transform so we can get original index pattern @@ -200,13 +136,16 @@ export class AnalyticsManager { } } - private getAnalyticsModelElements(analyticsId: string): { + private getAnalyticsModelElements( + analyticsId: string, + analyticsCreateTime: number + ): { modelElement?: AnalyticsMapNodeElement; modelDetails?: any; edgeElement?: AnalyticsMapEdgeElement; } { - // Get inference model for analytics job and create model node - const analyticsModel = this.findJobModel(analyticsId); + // Get trained model for analytics job and create model node + const analyticsModel = this.findJobModel(analyticsId, analyticsCreateTime); let modelElement; let edgeElement; @@ -260,12 +199,13 @@ export class AnalyticsManager { * Prepares the initial elements for incoming modelId * @param modelId */ - async getInitialElementsModelRoot(modelId: string): Promise { + private async getInitialElementsModelRoot(modelId: string): Promise { const resultElements = []; const modelElements = []; const details: any = {}; + let data: estypes.MlTrainedModelConfig | estypes.MlDataframeAnalyticsSummary; // fetch model data and create model elements - let data = await this.getAnalyticsModelData(modelId); + data = this.findTrainedModel(modelId); const modelNodeId = `${data.model_id}-${JOB_MAP_NODE_TYPES.TRAINED_MODEL}`; // @ts-expect-error @elastic-elasticsearch Data frame types incomplete const sourceJobId = data?.metadata?.analytics_config?.id; @@ -286,22 +226,18 @@ export class AnalyticsManager { // fetch source job data and create elements if (sourceJobId !== undefined) { try { - // @ts-expect-error @elastic-elasticsearch Data frame types incompletes - data = await this.getAnalyticsData(sourceJobId); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete + data = this.findJob(sourceJobId); + nextLinkId = data?.source?.index[0]; nextType = JOB_MAP_NODE_TYPES.INDEX; - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete previousNodeId = `${data.id}-${JOB_MAP_NODE_TYPES.ANALYTICS}`; resultElements.push({ data: { id: previousNodeId, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete label: data.id, type: JOB_MAP_NODE_TYPES.ANALYTICS, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete analysisType: getAnalysisType(data?.analysis), }, }); @@ -330,25 +266,25 @@ export class AnalyticsManager { * Prepares the initial elements for incoming jobId * @param jobId */ - async getInitialElementsJobRoot(jobId: string): Promise { + private async getInitialElementsJobRoot( + jobId: string, + jobCreateTime: number + ): Promise { const resultElements = []; const modelElements = []; const details: any = {}; - const data = await this.getAnalyticsData(jobId); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete + const data = this.findJob(jobId); + const nextLinkId = data?.source?.index[0]; const nextType: JobMapNodeTypes = JOB_MAP_NODE_TYPES.INDEX; - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete const previousNodeId = `${data.id}-${JOB_MAP_NODE_TYPES.ANALYTICS}`; resultElements.push({ data: { id: previousNodeId, - // @ts-expect-error @elastic-elasticsearch Data frame types incompletes label: data.id, type: JOB_MAP_NODE_TYPES.ANALYTICS, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete analysisType: getAnalysisType(data?.analysis), isRoot: true, }, @@ -356,7 +292,10 @@ export class AnalyticsManager { details[previousNodeId] = data; - const { modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements(jobId); + const { modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements( + jobId, + jobCreateTime + ); if (isAnalyticsMapNodeElement(modelElement)) { modelElements.push(modelElement); details[modelElement.data.id] = modelDetails; @@ -373,7 +312,7 @@ export class AnalyticsManager { * @param jobId (optional) * @param modelId (optional) */ - async getAnalyticsMap({ + public async getAnalyticsMap({ analyticsId, modelId, }: GetAnalyticsMapArgs): Promise { @@ -382,11 +321,13 @@ export class AnalyticsManager { const indexPatternElements: MapElements[] = []; try { - await Promise.all([this.setInferenceModels(), this.setJobStats()]); + await this.initData(); // Create first node for incoming analyticsId or modelId let initialData: InitialElementsReturnType = {} as InitialElementsReturnType; - if (analyticsId !== undefined) { - initialData = await this.getInitialElementsJobRoot(analyticsId); + const job = analyticsId === undefined ? undefined : this.findJob(analyticsId); + if (analyticsId !== undefined && job !== undefined) { + const jobCreateTime = job.create_time!; + initialData = await this.getInitialElementsJobRoot(analyticsId, jobCreateTime); } else if (modelId !== undefined) { initialData = await this.getInitialElementsModelRoot(modelId); } @@ -486,8 +427,11 @@ export class AnalyticsManager { nextLinkId = data?.source?.index[0]; nextType = JOB_MAP_NODE_TYPES.INDEX; - // Get inference model for analytics job and create model node - ({ modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements(data.id)); + // Get trained model for analytics job and create model node + ({ modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements( + data.id, + data.create_time + )); if (isAnalyticsMapNodeElement(modelElement)) { modelElements.push(modelElement); result.details[modelElement.data.id] = modelDetails; @@ -534,30 +478,23 @@ export class AnalyticsManager { // fetch all jobs associated with root transform if defined, otherwise check root index if (rootTransform !== undefined || rootIndexPattern !== undefined) { - const jobs = await this.getAnalyticsData(); + const jobs = this._jobs; const comparator = rootTransform !== undefined ? rootTransform : rootIndexPattern; - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete for (let i = 0; i < jobs.length; i++) { if ( - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete jobs[i]?.source?.index[0] === comparator && - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete this.isDuplicateElement(jobs[i].id, result.elements) === false ) { - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete const nodeId = `${jobs[i].id}-${JOB_MAP_NODE_TYPES.ANALYTICS}`; result.elements.push({ data: { id: nodeId, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete label: jobs[i].id, type: JOB_MAP_NODE_TYPES.ANALYTICS, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete analysisType: getAnalysisType(jobs[i]?.analysis), }, }); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete result.details[nodeId] = jobs[i]; const source = `${comparator}-${JOB_MAP_NODE_TYPES.INDEX}`; result.elements.push({ @@ -567,10 +504,10 @@ export class AnalyticsManager { target: nodeId, }, }); - // Get inference model for analytics job and create model node + // Get trained model for analytics job and create model node ({ modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements( - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete - jobs[i].id + jobs[i].id, + jobs[i].create_time! )); if (isAnalyticsMapNodeElement(modelElement)) { modelElements.push(modelElement); @@ -592,32 +529,31 @@ export class AnalyticsManager { } } - async extendAnalyticsMapForAnalyticsJob({ + public async extendAnalyticsMapForAnalyticsJob({ analyticsId, index, }: ExtendAnalyticsMapArgs): Promise { const result: AnalyticsMapReturnType = { elements: [], details: {}, error: null }; try { - await Promise.all([this.setInferenceModels(), this.setJobStats()]); - const jobs = await this.getAnalyticsData(); + await this.initData(); + const jobs = this._jobs; let rootIndex; let rootIndexNodeId; if (analyticsId !== undefined) { - const jobData = await this.getAnalyticsData(analyticsId); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete + const jobData = this.findJob(analyticsId); + const currentJobNodeId = `${jobData.id}-${JOB_MAP_NODE_TYPES.ANALYTICS}`; - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete rootIndex = Array.isArray(jobData?.dest?.index) - ? // @ts-expect-error @elastic-elasticsearch Data frame types incomplete - jobData?.dest?.index[0] - : // @ts-expect-error @elastic-elasticsearch Data frame types incomplete - jobData?.dest?.index; + ? jobData?.dest?.index[0] + : jobData?.dest?.index; rootIndexNodeId = `${rootIndex}-${JOB_MAP_NODE_TYPES.INDEX}`; - // Fetch inference model for incoming job id and add node and edge - const { modelElement, modelDetails, edgeElement } = - this.getAnalyticsModelElements(analyticsId); + // Fetch trained model for incoming job id and add node and edge + const { modelElement, modelDetails, edgeElement } = this.getAnalyticsModelElements( + analyticsId, + jobData.create_time! + ); if (isAnalyticsMapNodeElement(modelElement)) { result.elements.push(modelElement); result.details[modelElement.data.id] = modelDetails; @@ -650,28 +586,21 @@ export class AnalyticsManager { rootIndexNodeId = `${rootIndex}-${JOB_MAP_NODE_TYPES.INDEX}`; } - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete for (let i = 0; i < jobs.length; i++) { if ( - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete jobs[i]?.source?.index[0] === rootIndex && - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete this.isDuplicateElement(jobs[i].id, result.elements) === false ) { // Create node for associated job - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete const nodeId = `${jobs[i].id}-${JOB_MAP_NODE_TYPES.ANALYTICS}`; result.elements.push({ data: { id: nodeId, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete label: jobs[i].id, type: JOB_MAP_NODE_TYPES.ANALYTICS, - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete analysisType: getAnalysisType(jobs[i]?.analysis), }, }); - // @ts-expect-error @elastic-elasticsearch Data frame types incomplete result.details[nodeId] = jobs[i]; result.elements.push({ diff --git a/x-pack/plugins/ml/server/models/data_frame_analytics/models_provider.ts b/x-pack/plugins/ml/server/models/data_frame_analytics/models_provider.ts index 4ee77f06eac1f..1f6bb64fd76f4 100644 --- a/x-pack/plugins/ml/server/models/data_frame_analytics/models_provider.ts +++ b/x-pack/plugins/ml/server/models/data_frame_analytics/models_provider.ts @@ -112,7 +112,6 @@ export function modelsProvider(client: IScopedClusterClient, mlClient: MlClient) */ async getNodesOverview(): Promise { // TODO set node_id to ml:true when elasticsearch client is updated. - // @ts-expect-error typo in type definition: MlGetMemoryStatsResponse.cluser_name const response = (await mlClient.getMemoryStats()) as MemoryStatsResponse; const { trained_model_stats: trainedModelStats } = await mlClient.getTrainedModelsStats({ diff --git a/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts b/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts index 9bf107106a056..7060d935b0fef 100644 --- a/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts +++ b/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts @@ -17,6 +17,7 @@ import type { import moment from 'moment'; import { merge } from 'lodash'; import type { DataViewsService } from '@kbn/data-views-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { AnalysisLimits } from '../../../common/types/anomaly_detection_jobs'; import { getAuthorizationHeader } from '../../lib/request_authorization'; import type { MlClient } from '../../lib/ml_client'; @@ -54,7 +55,6 @@ import type { JobExistResult, JobStat } from '../../../common/types/data_recogni import type { Datafeed } from '../../../common/types/anomaly_detection_jobs'; import type { MLSavedObjectService } from '../../saved_objects'; import { isDefined } from '../../../common/types/guards'; -import { isPopulatedObject } from '../../../common/util/object_utils'; const ML_DIR = 'ml'; const KIBANA_DIR = 'kibana'; diff --git a/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts b/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts index bbfc43257caf5..6946a2fbda90f 100644 --- a/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts +++ b/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts @@ -5,21 +5,23 @@ * 2.0. */ -import { IScopedClusterClient } from '@kbn/core/server'; import { get, each, last, find } from 'lodash'; + +import { IScopedClusterClient } from '@kbn/core/server'; import { KBN_FIELD_TYPES } from '@kbn/data-plugin/server'; -import { ML_JOB_FIELD_TYPES } from '../../../common/constants/field_types'; -import { getSafeAggregationName } from '../../../common/util/job_utils'; -import { stringHash } from '../../../common/util/string_utils'; import { - buildBaseFilterCriteria, buildSamplerAggregation, + getAggIntervals, getSamplerAggregationsResponsePath, -} from '../../lib/query_utils'; +} from '@kbn/ml-agg-utils'; +import { stringHash } from '@kbn/ml-string-hash'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; +import { ML_JOB_FIELD_TYPES } from '../../../common/constants/field_types'; +import { getSafeAggregationName } from '../../../common/util/job_utils'; +import { buildBaseFilterCriteria } from '../../lib/query_utils'; import { AggCardinality, RuntimeMappings } from '../../../common/types/fields'; import { getDatafeedAggregations } from '../../../common/util/datafeed_utils'; import { Datafeed } from '../../../common/types/anomaly_detection_jobs'; -import { isPopulatedObject } from '../../../common/util/object_utils'; const SAMPLER_TOP_TERMS_THRESHOLD = 100000; const SAMPLER_TOP_TERMS_SHARD_SIZE = 5000; @@ -112,13 +114,6 @@ interface FieldExamples { examples: any[]; } -interface NumericColumnStats { - interval: number; - min: number; - max: number; -} -type NumericColumnStatsMap = Record; - interface AggHistogram { histogram: { field: string; @@ -178,67 +173,6 @@ type BatchStats = | DocumentCountStats | FieldExamples; -const getAggIntervals = async ( - { asCurrentUser }: IScopedClusterClient, - indexPattern: string, - query: any, - fields: HistogramField[], - samplerShardSize: number, - runtimeMappings?: RuntimeMappings -): Promise => { - const numericColumns = fields.filter((field) => { - return field.type === KBN_FIELD_TYPES.NUMBER || field.type === KBN_FIELD_TYPES.DATE; - }); - - if (numericColumns.length === 0) { - return {}; - } - - const minMaxAggs = numericColumns.reduce((aggs, c) => { - const id = stringHash(c.fieldName); - aggs[id] = { - stats: { - field: c.fieldName, - }, - }; - return aggs; - }, {} as Record); - - const body = await asCurrentUser.search( - { - index: indexPattern, - size: 0, - body: { - query, - aggs: buildSamplerAggregation(minMaxAggs, samplerShardSize), - size: 0, - ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), - }, - }, - { maxRetries: 0 } - ); - - const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); - const aggregations = aggsPath.length > 0 ? get(body.aggregations, aggsPath) : body.aggregations; - - return Object.keys(aggregations).reduce((p, aggName) => { - const stats = [aggregations[aggName].min, aggregations[aggName].max]; - if (!stats.includes(null)) { - const delta = aggregations[aggName].max - aggregations[aggName].min; - - let aggInterval = 1; - - if (delta > MAX_CHART_COLUMNS || delta <= 1) { - aggInterval = delta / (MAX_CHART_COLUMNS - 1); - } - - p[aggName] = { interval: aggInterval, min: stats[0], max: stats[1] }; - } - - return p; - }, {} as NumericColumnStatsMap); -}; - // export for re-use by transforms plugin export const getHistogramsForFields = async ( client: IScopedClusterClient, @@ -250,7 +184,7 @@ export const getHistogramsForFields = async ( ) => { const { asCurrentUser } = client; const aggIntervals = await getAggIntervals( - client, + client.asCurrentUser, indexPattern, query, fields, diff --git a/x-pack/plugins/ml/server/models/fields_service/fields_service.ts b/x-pack/plugins/ml/server/models/fields_service/fields_service.ts index 64348a0656009..fd661063bde5f 100644 --- a/x-pack/plugins/ml/server/models/fields_service/fields_service.ts +++ b/x-pack/plugins/ml/server/models/fields_service/fields_service.ts @@ -8,6 +8,7 @@ import Boom from '@hapi/boom'; import { IScopedClusterClient } from '@kbn/core/server'; import { duration } from 'moment'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { parseInterval } from '../../../common/util/parse_interval'; import { initCardinalityFieldsCache } from './fields_aggs_cache'; import { AggCardinality } from '../../../common/types/fields'; @@ -15,7 +16,6 @@ import { isValidAggregationField } from '../../../common/util/validation_utils'; import { getDatafeedAggregations } from '../../../common/util/datafeed_utils'; import { Datafeed, IndicesOptions } from '../../../common/types/anomaly_detection_jobs'; import { RuntimeMappings } from '../../../common/types/fields'; -import { isPopulatedObject } from '../../../common/util/object_utils'; /** * Service for carrying out queries to obtain data diff --git a/x-pack/plugins/ml/server/models/job_service/jobs.ts b/x-pack/plugins/ml/server/models/job_service/jobs.ts index 1ffa9687fca95..f3cb4c584f27f 100644 --- a/x-pack/plugins/ml/server/models/job_service/jobs.ts +++ b/x-pack/plugins/ml/server/models/job_service/jobs.ts @@ -9,6 +9,7 @@ import { uniq } from 'lodash'; import Boom from '@hapi/boom'; import { IScopedClusterClient } from '@kbn/core/server'; import type { RulesClient } from '@kbn/alerting-plugin/server'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { getSingleMetricViewerJobErrorMessage, parseTimeIntervalForJob, @@ -47,7 +48,6 @@ import { } from '../../../common/util/job_utils'; import { groupsProvider } from './groups'; import type { MlClient } from '../../lib/ml_client'; -import { isPopulatedObject } from '../../../common/util/object_utils'; import { ML_ALERT_TYPES } from '../../../common/constants/alerts'; import { MlAnomalyDetectionAlertParams } from '../../routes/schemas/alerting_schema'; import type { AuthorizationHeader } from '../../lib/request_authorization'; diff --git a/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts b/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts index dd7e2b3373e89..9456e529eb039 100644 --- a/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts +++ b/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts @@ -10,8 +10,9 @@ import { i18n } from '@kbn/i18n'; import { each, find, get, keyBy, map, reduce, sortBy } from 'lodash'; import type * as estypes from '@elastic/elasticsearch/lib/api/types'; import { extent, max, min } from 'd3'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { MlClient } from '../../lib/ml_client'; -import { isPopulatedObject, isRuntimeMappings } from '../../../common'; +import { isRuntimeMappings } from '../../../common'; import type { MetricData, ModelPlotOutput, diff --git a/x-pack/plugins/ml/server/models/results_service/results_service.ts b/x-pack/plugins/ml/server/models/results_service/results_service.ts index 5af471bf44997..ec4a3425eaa2b 100644 --- a/x-pack/plugins/ml/server/models/results_service/results_service.ts +++ b/x-pack/plugins/ml/server/models/results_service/results_service.ts @@ -657,7 +657,6 @@ export function resultsServiceProvider(mlClient: MlClient, client?: IScopedClust datafeedResults: [], annotationResultsRect: [], annotationResultsLine: [], - modelSnapshotResultsLine: [], }; const { getDatafeedByJobId } = datafeedsProvider(client!, mlClient); @@ -739,7 +738,7 @@ export function resultsServiceProvider(mlClient: MlClient, client?: IScopedClust const { getAnnotations } = annotationServiceProvider(client!); - const [bucketResp, annotationResp, modelSnapshotsResp] = await Promise.all([ + const [bucketResp, annotationResp] = await Promise.all([ mlClient.getBuckets({ job_id: jobId, body: { desc: true, start: String(start), end: String(end), page: { from: 0, size: 1000 } }, @@ -750,11 +749,6 @@ export function resultsServiceProvider(mlClient: MlClient, client?: IScopedClust latestMs: end, maxAnnotations: 1000, }), - mlClient.getModelSnapshots({ - job_id: jobId, - start: String(start), - end: String(end), - }), ]); const bucketResults = bucketResp?.buckets ?? []; @@ -786,16 +780,6 @@ export function resultsServiceProvider(mlClient: MlClient, client?: IScopedClust } }); - const modelSnapshots = modelSnapshotsResp?.model_snapshots ?? []; - modelSnapshots.forEach((modelSnapshot) => { - const timestamp = Number(modelSnapshot?.timestamp); - - finalResults.modelSnapshotResultsLine.push({ - dataValue: timestamp, - details: modelSnapshot.description, - }); - }); - return finalResults; } diff --git a/x-pack/plugins/ml/server/routes/trained_models.ts b/x-pack/plugins/ml/server/routes/trained_models.ts index 849d3b04d8cef..1fcfe4e1fa05e 100644 --- a/x-pack/plugins/ml/server/routes/trained_models.ts +++ b/x-pack/plugins/ml/server/routes/trained_models.ts @@ -377,7 +377,7 @@ export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization) routeGuard.fullLicenseAPIGuard(async ({ mlClient, request, response }) => { try { const { modelId } = request.params; - const body = await mlClient.inferTrainedModelDeployment({ + const body = await mlClient.inferTrainedModel({ model_id: modelId, body: { docs: request.body.docs, diff --git a/x-pack/plugins/monitoring/public/components/cluster/overview/__snapshots__/helpers.test.js.snap b/x-pack/plugins/monitoring/public/components/cluster/overview/__snapshots__/helpers.test.js.snap index ea9d312413168..4c98f55472c8e 100644 --- a/x-pack/plugins/monitoring/public/components/cluster/overview/__snapshots__/helpers.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/cluster/overview/__snapshots__/helpers.test.js.snap @@ -3,7 +3,7 @@ exports[`Bytes Usage should format correctly with only usedBytes 1`] = `
50.0 B
@@ -13,7 +13,7 @@ exports[`Bytes Usage should format correctly with only usedBytes 1`] = ` exports[`Bytes Usage should format correctly with used and max bytes 1`] = `
50.0 B / 100.0 B
@@ -23,25 +23,21 @@ exports[`Bytes Usage should format correctly with used and max bytes 1`] = ` exports[`BytesPercentageUsage should format correctly with used bytes and max bytes 1`] = `
50.00%
-
- 50.0 B / 100.0 B -
+ 50.0 B / 100.0 B
`; exports[`BytesPercentageUsage should return zero bytes if both parameters are not present 1`] = `
0
diff --git a/x-pack/plugins/monitoring/public/components/elasticsearch/ccr_shard/__snapshots__/ccr_shard.test.js.snap b/x-pack/plugins/monitoring/public/components/elasticsearch/ccr_shard/__snapshots__/ccr_shard.test.js.snap index 3647945c094cb..e0b6f737ce798 100644 --- a/x-pack/plugins/monitoring/public/components/elasticsearch/ccr_shard/__snapshots__/ccr_shard.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/elasticsearch/ccr_shard/__snapshots__/ccr_shard.test.js.snap @@ -123,8 +123,7 @@ exports[`CcrShard that it renders normally 1`] = ` -

@@ -136,12 +135,7 @@ exports[`CcrShard that it renders normally 1`] = `

} - buttonElement="button" - element="div" id="ccrLatestStat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} paddingSize="l" > - + `; diff --git a/x-pack/plugins/monitoring/public/components/elasticsearch/nodes/__snapshots__/cells.test.js.snap b/x-pack/plugins/monitoring/public/components/elasticsearch/nodes/__snapshots__/cells.test.js.snap index 5535520c67a8e..527e68fbec1ad 100644 --- a/x-pack/plugins/monitoring/public/components/elasticsearch/nodes/__snapshots__/cells.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/elasticsearch/nodes/__snapshots__/cells.test.js.snap @@ -52,7 +52,7 @@ exports[`Node Listing Metric Cell should format a non-percentage metric 1`] = ` class="euiFlexItem euiFlexItem--flexGrowZero" >
206.3 GB
@@ -106,7 +106,7 @@ exports[`Node Listing Metric Cell should format a percentage metric 1`] = ` class="euiFlexItem euiFlexItem--flexGrowZero" >
0%
diff --git a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/checker_errors.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/checker_errors.test.js.snap index 249ccd701ee6e..76868f50ef1ab 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/checker_errors.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/checker_errors.test.js.snap @@ -8,7 +8,7 @@ Array [ class="euiSpacer euiSpacer--l css-p2o3x6-euiSpacer-l" />,

-
+ There were some errors encountered in trying to check Elasticsearch settings. You need administrator rights to check the settings and, if needed, to enable the monitoring collection setting. +

+
-

- There were some errors encountered in trying to check Elasticsearch settings. You need administrator rights to check the settings and, if needed, to enable the monitoring collection setting. -

-
-
- 403 Forbidden -
-
- no access for you -
-
- 500 Internal Server Error -
-
- An internal server error occurred -
-
-
+ 403 Forbidden + +
+ no access for you +
+
+ 500 Internal Server Error +
+
+ An internal server error occurred +
+
, ] diff --git a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap index 294adee15f725..67681016d7a95 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/__snapshots__/no_data.test.js.snap @@ -15,7 +15,7 @@ exports[`NoData should show a default message if reason is unknown 1`] = ` style="max-width:600px" >

Have you set up monitoring yet? If so, make sure that the selected time period in the upper right includes monitoring data. @@ -83,7 +83,7 @@ exports[`NoData should show a default message if reason is unknown 1`] = ` class="euiButtonEmpty__text" > Or, set up with self monitoring @@ -110,7 +110,7 @@ exports[`NoData should show text next to the spinner while checking a setting 1` style="max-width:600px" >

Have you set up monitoring yet? If so, make sure that the selected time period in the upper right includes monitoring data. @@ -178,7 +178,7 @@ exports[`NoData should show text next to the spinner while checking a setting 1` class="euiButtonEmpty__text" > Or, set up with self monitoring diff --git a/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_enabled/__snapshots__/collection_enabled.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_enabled/__snapshots__/collection_enabled.test.js.snap index 392a01421747d..e876c673a3f7c 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_enabled/__snapshots__/collection_enabled.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_enabled/__snapshots__/collection_enabled.test.js.snap @@ -8,10 +8,10 @@ Array [ Monitoring is currently off ,

Monitoring provides insight to your hardware performance and load. @@ -22,7 +22,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the cluster settings and found that diff --git a/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_interval/__snapshots__/collection_interval.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_interval/__snapshots__/collection_interval.test.js.snap index dbe1886197c51..a065c2fc3a61d 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_interval/__snapshots__/collection_interval.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/explanations/collection_interval/__snapshots__/collection_interval.test.js.snap @@ -11,7 +11,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

As soon as monitoring data appears in your cluster the page will automatically refresh with your monitoring dashboard. This only takes only a few seconds. @@ -36,10 +36,10 @@ Array [ Monitoring is currently off ,

Monitoring provides insight to your hardware performance and load. @@ -50,7 +50,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the cluster settings and found that @@ -113,10 +113,10 @@ Array [ Monitoring is currently off ,

Monitoring provides insight to your hardware performance and load. @@ -127,7 +127,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the cluster settings and found that diff --git a/x-pack/plugins/monitoring/public/components/no_data/explanations/exporters/__snapshots__/exporters.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/explanations/exporters/__snapshots__/exporters.test.js.snap index fb8c2d859336b..191900a6d40e9 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/explanations/exporters/__snapshots__/exporters.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/explanations/exporters/__snapshots__/exporters.test.js.snap @@ -8,10 +8,10 @@ Array [ You need to make some adjustments ,

To run monitoring please perform the following steps @@ -22,7 +22,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the @@ -72,10 +72,10 @@ Array [ exports[`ExplainExportersCloud should explain about xpack.monitoring.exporters setting in a cloud environment 1`] = ` Array [

Configure monitoring through @@ -145,7 +145,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

In Elastic Cloud, your monitoring data is stored in your dedicated monitoring cluster. diff --git a/x-pack/plugins/monitoring/public/components/no_data/explanations/plugin_enabled/__snapshots__/plugin_enabled.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/explanations/plugin_enabled/__snapshots__/plugin_enabled.test.js.snap index d81a0b879ed3c..b16d2cef833e9 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/explanations/plugin_enabled/__snapshots__/plugin_enabled.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/explanations/plugin_enabled/__snapshots__/plugin_enabled.test.js.snap @@ -8,10 +8,10 @@ Array [ You need to make some adjustments ,

To run monitoring please perform the following steps @@ -22,7 +22,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the cluster settings and found that diff --git a/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/reason_found.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/reason_found.test.js.snap index 93cd6db411d29..e91654a721305 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/reason_found.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/reason_found.test.js.snap @@ -8,10 +8,10 @@ Array [ Monitoring is currently off ,

Monitoring provides insight to your hardware performance and load. @@ -22,7 +22,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the cluster settings and found that @@ -79,10 +79,10 @@ Array [ You need to make some adjustments ,

To run monitoring please perform the following steps @@ -93,7 +93,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the @@ -143,10 +143,10 @@ Array [ exports[`ReasonFound should load ExplainExportersCloud component 1`] = ` Array [

Configure monitoring through @@ -216,7 +216,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

In Elastic Cloud, your monitoring data is stored in your dedicated monitoring cluster. @@ -233,10 +233,10 @@ Array [ You need to make some adjustments ,

To run monitoring please perform the following steps @@ -247,7 +247,7 @@ Array [ class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />,

We checked the node001foo settings and found that diff --git a/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/we_tried.test.js.snap b/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/we_tried.test.js.snap index ee0c34f529298..b5c2527dd7a2b 100644 --- a/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/we_tried.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/no_data/reasons/__snapshots__/we_tried.test.js.snap @@ -13,7 +13,7 @@ exports[`WeTried should render "we tried" message 1`] = ` class="euiHorizontalRule euiHorizontalRule--half euiHorizontalRule--marginLarge css-16ybxy8-euiHorizontalRule-half-l" />

No monitoring data found. Try setting the time filter to "Last 1 hour" or check if data is available for a different time period. diff --git a/x-pack/plugins/monitoring/public/components/page_loading/__snapshots__/page_loading.test.js.snap b/x-pack/plugins/monitoring/public/components/page_loading/__snapshots__/page_loading.test.js.snap index 39ef893984c7d..431c1d327afe8 100644 --- a/x-pack/plugins/monitoring/public/components/page_loading/__snapshots__/page_loading.test.js.snap +++ b/x-pack/plugins/monitoring/public/components/page_loading/__snapshots__/page_loading.test.js.snap @@ -9,7 +9,7 @@ exports[`PageLoading should show a simple page loading component 1`] = ` class="euiPageBody euiPageBody--borderRadiusNone" >

+

{i18n.translate('xpack.painlessLab.context.defaultLabel', { defaultMessage: 'The script result will be converted to a string', })} @@ -50,7 +50,7 @@ export const painlessContextOptions: Array <> {filterLabel} -

+

{i18n.translate('xpack.painlessLab.context.filterLabel', { defaultMessage: "Use the context of a filter's script query", })} @@ -67,7 +67,7 @@ export const painlessContextOptions: Array <> {scoreLabel} -

+

{i18n.translate('xpack.painlessLab.context.scoreLabel', { defaultMessage: 'Use the context of a script_score function in function_score query', })} diff --git a/x-pack/plugins/reporting/public/share_context_menu/__snapshots__/screen_capture_panel_content.test.tsx.snap b/x-pack/plugins/reporting/public/share_context_menu/__snapshots__/screen_capture_panel_content.test.tsx.snap index 6065e63aacba4..6f7223b999d0b 100644 --- a/x-pack/plugins/reporting/public/share_context_menu/__snapshots__/screen_capture_panel_content.test.tsx.snap +++ b/x-pack/plugins/reporting/public/share_context_menu/__snapshots__/screen_capture_panel_content.test.tsx.snap @@ -6,7 +6,7 @@ exports[`ScreenCapturePanelContent properly renders a view with "canvas" layout data-test-subj="shareReportingForm" >

@@ -101,13 +101,13 @@ exports[`ScreenCapturePanelContent properly renders a view with "canvas" layout class="euiAccordion" >

@@ -159,7 +159,7 @@ exports[`ScreenCapturePanelContent properly renders a view with "canvas" layout class="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

-
-

- - Save your work before copying this URL. - -

-
-
+

+ + Save your work before copying this URL. + +

+
@@ -206,7 +202,7 @@ exports[`ScreenCapturePanelContent properly renders a view with "print" layout o data-test-subj="shareReportingForm" >

@@ -301,13 +297,13 @@ exports[`ScreenCapturePanelContent properly renders a view with "print" layout o class="euiAccordion" >

@@ -359,7 +355,7 @@ exports[`ScreenCapturePanelContent properly renders a view with "print" layout o class="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

-
-

- - Save your work before copying this URL. - -

-
-
+

+ + Save your work before copying this URL. + +

+
@@ -406,7 +398,7 @@ exports[`ScreenCapturePanelContent renders the default view properly 1`] = ` data-test-subj="shareReportingForm" >

@@ -442,13 +434,13 @@ exports[`ScreenCapturePanelContent renders the default view properly 1`] = ` class="euiAccordion" >

@@ -500,7 +492,7 @@ exports[`ScreenCapturePanelContent renders the default view properly 1`] = ` class="euiSpacer euiSpacer--s css-78drzl-euiSpacer-s" />

-
-

- - Save your work before copying this URL. - -

-
-
+

+ + Save your work before copying this URL. + +

+
diff --git a/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.test.tsx b/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.test.tsx index ffe5417616dd9..f3b63bf32b5ff 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.test.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.test.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import { EuiAccordion } from '@elastic/eui'; +import { EuiAccordion, EuiIconTip } from '@elastic/eui'; import React from 'react'; import type { KibanaFeature, SubFeatureConfig } from '@kbn/features-plugin/public'; @@ -33,11 +33,14 @@ interface TestConfig { calculateDisplayedPrivileges: boolean; canCustomizeSubFeaturePrivileges: boolean; } + const setup = (config: TestConfig) => { const kibanaPrivileges = createKibanaPrivileges(config.features, { allowSubFeaturePrivileges: config.canCustomizeSubFeaturePrivileges, }); + const calculator = new PrivilegeFormCalculator(kibanaPrivileges, config.role); + const onChange = jest.fn(); const onChangeAll = jest.fn(); const wrapper = mountWithIntl( @@ -120,6 +123,7 @@ describe('FeatureTable', () => { feature: {}, }, ]); + const { displayedPrivileges } = setup({ role, features: kibanaFeatures, @@ -127,6 +131,7 @@ describe('FeatureTable', () => { calculateDisplayedPrivileges: true, canCustomizeSubFeaturePrivileges, }); + expect(displayedPrivileges).toEqual({ excluded_from_base: { primaryFeaturePrivilege: 'none', @@ -271,6 +276,7 @@ describe('FeatureTable', () => { }, }, ]); + const { displayedPrivileges } = setup({ role, features: kibanaFeatures, @@ -312,6 +318,7 @@ describe('FeatureTable', () => { feature: {}, }, ]); + const { wrapper } = setup({ role, features: kibanaFeatures, @@ -325,6 +332,7 @@ describe('FeatureTable', () => { .find(EuiAccordion) .filter(`#featurePrivilegeControls_${feature.id}`) .props(); + if (!feature.subFeatures || feature.subFeatures.length === 0) { expect(arrowDisplay).toEqual('none'); } else { @@ -941,4 +949,334 @@ describe('FeatureTable', () => { `"2 / 2 features granted"` ); }); + + describe('Info Icon Tooltip for Customized Subfeature privileges', () => { + it('should render if there are custom privileges and the accordion is toggled open then toggled closed', () => { + const role = createRole([ + { + spaces: ['foo'], + base: [], + feature: { + unit_test: ['minimal_read', 'sub-toggle-1', 'sub-toggle-2'], + }, + }, + ]); + + const feature = createFeature({ + id: 'unit_test', + name: 'Unit Test Feature', + subFeatures: [ + { + name: 'Some Sub Feature', + privilegeGroups: [ + { + groupType: 'independent', + privileges: [ + { + id: 'sub-toggle-1', + name: 'Sub Toggle 1', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-1'], + }, + { + id: 'sub-toggle-2', + name: 'Sub Toggle 2', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-2'], + }, + { + id: 'sub-toggle-3', + name: 'Sub Toggle 3', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-3'], + }, + ], + }, + ], + }, + ] as SubFeatureConfig[], + }); + + const { wrapper } = setup({ + role, + features: [feature], + privilegeIndex: 0, + calculateDisplayedPrivileges: false, + canCustomizeSubFeaturePrivileges: true, + }); + + const categoryExpander = findTestSubject(wrapper, 'featureCategoryButton_foo'); + categoryExpander.simulate('click'); + + const featureExpander = findTestSubject(wrapper, 'featureTableCell'); + featureExpander.simulate('click').simulate('click'); + + const { type } = wrapper.find(EuiIconTip).props(); + + expect(type).toBe('iInCircle'); + }); + + it('should render if there are custom privileges and the accordion has not been toggled (i.e. on load)', () => { + const role = createRole([ + { + spaces: ['foo'], + base: [], + feature: { + unit_test: ['minimal_read', 'sub-toggle-1', 'sub-toggle-2'], + }, + }, + ]); + + const feature = createFeature({ + id: 'unit_test', + name: 'Unit Test Feature', + subFeatures: [ + { + name: 'Some Sub Feature', + privilegeGroups: [ + { + groupType: 'independent', + privileges: [ + { + id: 'sub-toggle-1', + name: 'Sub Toggle 1', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-1'], + }, + { + id: 'sub-toggle-2', + name: 'Sub Toggle 2', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-2'], + }, + { + id: 'sub-toggle-3', + name: 'Sub Toggle 3', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-3'], + }, + ], + }, + ], + }, + ] as SubFeatureConfig[], + }); + + const { wrapper } = setup({ + role, + features: [feature], + privilegeIndex: 0, + calculateDisplayedPrivileges: false, + canCustomizeSubFeaturePrivileges: true, + }); + + const { type } = wrapper.find(EuiIconTip).props(); + + expect(type).toBe('iInCircle'); + }); + + it('should not render if there are custom privileges and the accordion is open', () => { + const role = createRole([ + { + spaces: ['foo'], + base: [], + feature: { + unit_test: ['minimal_read', 'sub-toggle-1', 'sub-toggle-2'], + }, + }, + ]); + + const feature = createFeature({ + id: 'unit_test', + name: 'Unit Test Feature', + subFeatures: [ + { + name: 'Some Sub Feature', + privilegeGroups: [ + { + groupType: 'independent', + privileges: [ + { + id: 'sub-toggle-1', + name: 'Sub Toggle 1', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-1'], + }, + { + id: 'sub-toggle-2', + name: 'Sub Toggle 2', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-2'], + }, + { + id: 'sub-toggle-3', + name: 'Sub Toggle 3', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-3'], + }, + ], + }, + ], + }, + ] as SubFeatureConfig[], + }); + + const { wrapper } = setup({ + role, + features: [feature], + privilegeIndex: 0, + calculateDisplayedPrivileges: false, + canCustomizeSubFeaturePrivileges: true, + }); + + const categoryExpander = findTestSubject(wrapper, 'featureCategoryButton_foo'); + categoryExpander.simulate('click'); + + const featureExpander = findTestSubject(wrapper, 'featureTableCell'); + featureExpander.simulate('click'); + + const { type } = wrapper.find(EuiIconTip).props(); + + expect(type).toBe('empty'); + }); + + it('should not render if there are NOT custom privileges and the accordion has not been toggled (i.e on load)', () => { + const role = createRole([ + { + spaces: ['foo'], + base: [], + feature: { + unit_test: ['all', 'sub-toggle-1', 'sub-toggle-2', 'sub-toggle-3'], + }, + }, + ]); + + const feature = createFeature({ + id: 'unit_test', + name: 'Unit Test Feature', + subFeatures: [ + { + name: 'Some Sub Feature', + privilegeGroups: [ + { + groupType: 'independent', + privileges: [ + { + id: 'sub-toggle-1', + name: 'Sub Toggle 1', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-1'], + }, + { + id: 'sub-toggle-2', + name: 'Sub Toggle 2', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-2'], + }, + { + id: 'sub-toggle-3', + name: 'Sub Toggle 3', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-3'], + }, + ], + }, + ], + }, + ] as SubFeatureConfig[], + }); + + const { wrapper } = setup({ + role, + features: [feature], + privilegeIndex: 0, + calculateDisplayedPrivileges: false, + canCustomizeSubFeaturePrivileges: true, + }); + + const { type } = wrapper.find(EuiIconTip).props(); + + expect(type).toBe('empty'); + }); + + it('should not render if there are NOT custom privileges and the accordion has been toggled open then toggled closed', () => { + const role = createRole([ + { + spaces: ['foo'], + base: [], + feature: { + unit_test: ['all', 'sub-toggle-1', 'sub-toggle-2', 'sub-toggle-3'], + }, + }, + ]); + + const feature = createFeature({ + id: 'unit_test', + name: 'Unit Test Feature', + subFeatures: [ + { + name: 'Some Sub Feature', + privilegeGroups: [ + { + groupType: 'independent', + privileges: [ + { + id: 'sub-toggle-1', + name: 'Sub Toggle 1', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-1'], + }, + { + id: 'sub-toggle-2', + name: 'Sub Toggle 2', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-2'], + }, + { + id: 'sub-toggle-3', + name: 'Sub Toggle 3', + includeIn: 'all', + savedObject: { all: [], read: [] }, + ui: ['sub-toggle-3'], + }, + ], + }, + ], + }, + ] as SubFeatureConfig[], + }); + + const { wrapper } = setup({ + role, + features: [feature], + privilegeIndex: 0, + calculateDisplayedPrivileges: false, + canCustomizeSubFeaturePrivileges: true, + }); + + const categoryExpander = findTestSubject(wrapper, 'featureCategoryButton_foo'); + categoryExpander.simulate('click'); + + const featureExpander = findTestSubject(wrapper, 'featureTableCell'); + featureExpander.simulate('click').simulate('click'); + + const { type } = wrapper.find(EuiIconTip).props(); + + expect(type).toBe('empty'); + }); + }); }); diff --git a/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.tsx b/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.tsx index 43d23fa7a584d..a506f8675bc11 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/privileges/kibana/feature_table/feature_table.tsx @@ -48,7 +48,11 @@ interface Props { disabled?: boolean; } -export class FeatureTable extends Component { +interface State { + expandedPrivilegeControls: Set; +} + +export class FeatureTable extends Component { public static defaultProps = { privilegeIndex: -1, showLocks: true, @@ -67,8 +71,11 @@ export class FeatureTable extends Component { if (!this.featureCategories.has(feature.category.id)) { this.featureCategories.set(feature.category.id, []); } + this.featureCategories.get(feature.category.id)!.push(feature); }); + + this.state = { expandedPrivilegeControls: new Set() }; } public render() { @@ -207,14 +214,14 @@ export class FeatureTable extends Component { const renderFeatureMarkup = ( buttonContent: EuiAccordionProps['buttonContent'], extraAction: EuiAccordionProps['extraAction'], - warningIcon: JSX.Element + infoIcon: JSX.Element ) => { const { canCustomizeSubFeaturePrivileges } = this.props; const hasSubFeaturePrivileges = feature.getSubFeaturePrivileges().length > 0; return ( - {warningIcon} + {infoIcon} { arrowDisplay={ canCustomizeSubFeaturePrivileges && hasSubFeaturePrivileges ? 'left' : 'none' } + onToggle={(isOpen: boolean) => { + if (isOpen) { + this.state.expandedPrivilegeControls.add(feature.id); + } else { + this.state.expandedPrivilegeControls.delete(feature.id); + } + + this.setState({ + expandedPrivilegeControls: new Set([...this.state.expandedPrivilegeControls]), + }); + }} >
{ isDisabled: this.props.disabled ?? false, }); - let warningIcon = ; + let infoIcon = ; + + const arePrivilegeControlsCollapsed = !this.state.expandedPrivilegeControls.has(feature.id); + if ( + arePrivilegeControlsCollapsed && this.props.privilegeCalculator.hasCustomizedSubFeaturePrivileges( feature.id, this.props.privilegeIndex, this.props.allSpacesSelected ) ) { - warningIcon = ( + infoIcon = ( { /> ); - return renderFeatureMarkup(buttonContent, extraAction, warningIcon); + return renderFeatureMarkup(buttonContent, extraAction, infoIcon); }; private onChange = (featureId: string) => (featurePrivilegeId: string) => { diff --git a/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap b/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap index e355dce44a387..5de000ed20207 100644 --- a/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap +++ b/x-pack/plugins/security/public/management/roles/roles_grid/__snapshots__/roles_grid_page.test.tsx.snap @@ -2,11 +2,11 @@ exports[` renders permission denied if required 1`] = `
renders permission denied if required 1`] = ` > You need permission to manage roles - +
-
-
-

- Contact your system administrator. -

-
- + Contact your system administrator. +

+
diff --git a/x-pack/plugins/security/server/__snapshots__/prompt_page.test.tsx.snap b/x-pack/plugins/security/server/__snapshots__/prompt_page.test.tsx.snap index 0033dca9c4e44..555ebf370b898 100644 --- a/x-pack/plugins/security/server/__snapshots__/prompt_page.test.tsx.snap +++ b/x-pack/plugins/security/server/__snapshots__/prompt_page.test.tsx.snap @@ -1,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`PromptPage renders as expected with additional scripts 1`] = `"ElasticMockedFonts

Some Title

Some Body
Action#1
Action#2
"`; +exports[`PromptPage renders as expected with additional scripts 1`] = `"ElasticMockedFonts

Some Title

Some Body
Action#1
Action#2
"`; -exports[`PromptPage renders as expected without additional scripts 1`] = `"ElasticMockedFonts

Some Title

Some Body
Action#1
Action#2
"`; +exports[`PromptPage renders as expected without additional scripts 1`] = `"ElasticMockedFonts

Some Title

Some Body
Action#1
Action#2
"`; diff --git a/x-pack/plugins/security/server/authentication/__snapshots__/unauthenticated_page.test.tsx.snap b/x-pack/plugins/security/server/authentication/__snapshots__/unauthenticated_page.test.tsx.snap index 2ec39e0654cbd..332491b1977aa 100644 --- a/x-pack/plugins/security/server/authentication/__snapshots__/unauthenticated_page.test.tsx.snap +++ b/x-pack/plugins/security/server/authentication/__snapshots__/unauthenticated_page.test.tsx.snap @@ -1,3 +1,3 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`UnauthenticatedPage renders as expected 1`] = `"ElasticMockedFonts

We couldn't log you in

We hit an authentication error. Please check your credentials and try again. If you still can't log in, contact your system administrator.

Log in
"`; +exports[`UnauthenticatedPage renders as expected 1`] = `"ElasticMockedFonts

We couldn't log you in

We hit an authentication error. Please check your credentials and try again. If you still can't log in, contact your system administrator.

Log in
"`; diff --git a/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap b/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap index 51a194be69443..6d5b5e40d592c 100644 --- a/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap +++ b/x-pack/plugins/security/server/authorization/__snapshots__/reset_session_page.test.tsx.snap @@ -1,3 +1,3 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`ResetSessionPage renders as expected 1`] = `"ElasticMockedFonts

You do not have permission to access the requested page

Either go back to the previous page or log in as a different user.

Log in as different user
"`; +exports[`ResetSessionPage renders as expected 1`] = `"ElasticMockedFonts

You do not have permission to access the requested page

Either go back to the previous page or log in as a different user.

Log in as different user
"`; diff --git a/x-pack/plugins/security_solution/common/endpoint/constants.ts b/x-pack/plugins/security_solution/common/endpoint/constants.ts index 13747e53025c7..6d4a3407e644b 100644 --- a/x-pack/plugins/security_solution/common/endpoint/constants.ts +++ b/x-pack/plugins/security_solution/common/endpoint/constants.ts @@ -58,7 +58,7 @@ const BASE_ENDPOINT_ACTION_ROUTE = `${BASE_ENDPOINT_ROUTE}/action`; /** Action Response Routes */ export const ISOLATE_HOST_ROUTE_V2 = `${BASE_ENDPOINT_ACTION_ROUTE}/isolate`; -export const RELEASE_HOST_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/release`; +export const UNISOLATE_HOST_ROUTE_V2 = `${BASE_ENDPOINT_ACTION_ROUTE}/unisolate`; export const GET_RUNNING_PROCESSES_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/running_procs`; export const KILL_PROCESS_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/kill_process`; export const SUSPEND_PROCESS_ROUTE = `${BASE_ENDPOINT_ACTION_ROUTE}/suspend_process`; diff --git a/x-pack/plugins/security_solution/common/endpoint/models/policy_config.ts b/x-pack/plugins/security_solution/common/endpoint/models/policy_config.ts index 6b470c85aa1b8..e2cb3503910be 100644 --- a/x-pack/plugins/security_solution/common/endpoint/models/policy_config.ts +++ b/x-pack/plugins/security_solution/common/endpoint/models/policy_config.ts @@ -149,6 +149,13 @@ export const policyFactoryWithoutPaidFeatures = ( ...policy, windows: { ...policy.windows, + advanced: + policy.windows.advanced === undefined + ? undefined + : { + ...policy.windows.advanced, + rollback: undefined, + }, ransomware: { mode: ProtectionModes.off, supported: false, diff --git a/x-pack/plugins/security_solution/common/endpoint/types/index.ts b/x-pack/plugins/security_solution/common/endpoint/types/index.ts index 72a1b3e2a4bee..28aa5052db48c 100644 --- a/x-pack/plugins/security_solution/common/endpoint/types/index.ts +++ b/x-pack/plugins/security_solution/common/endpoint/types/index.ts @@ -911,7 +911,10 @@ type KbnConfigSchemaNonOptionalProps> = Pi */ export interface PolicyConfig { windows: { - advanced?: {}; + advanced?: { + [key: string]: unknown; + rollback?: string | boolean; + }; events: { dll_and_driver_load: boolean; dns: boolean; diff --git a/x-pack/plugins/security_solution/common/license/policy_config.test.ts b/x-pack/plugins/security_solution/common/license/policy_config.test.ts index e62b063fd3dfe..40b57207a4d72 100644 --- a/x-pack/plugins/security_solution/common/license/policy_config.test.ts +++ b/x-pack/plugins/security_solution/common/license/policy_config.test.ts @@ -123,6 +123,23 @@ describe('policy_config and licenses', () => { expect(valid).toBeTruthy(); }); + it('allows advanced rollback option when Platinum', () => { + const policy = policyFactory(); + policy.windows.advanced = { rollback: true }; // make policy change + const valid = isEndpointPolicyValidForLicense(policy, Platinum); + expect(valid).toBeTruthy(); + }); + + it('blocks advanced rollback option when below Platinum', () => { + const policy = policyFactory(); + policy.windows.advanced = { rollback: true }; // make policy change + let valid = isEndpointPolicyValidForLicense(policy, Gold); + expect(valid).toBeFalsy(); + + valid = isEndpointPolicyValidForLicense(policy, Basic); + expect(valid).toBeFalsy(); + }); + describe('ransomware protection checks', () => { it('blocks ransomware to be turned on for Gold and below licenses', () => { const policy = policyFactoryWithoutPaidFeatures(); @@ -474,6 +491,21 @@ describe('policy_config and licenses', () => { ); }); + it('resets Platinum-paid advanced fields for lower license tiers', () => { + const defaults = policyFactoryWithoutPaidFeatures(); // reference + const policy = policyFactory(); // what we will modify, and should be reset + + policy.windows.advanced = { rollback: true }; + policy.windows.advanced = { another_advanced: true }; + + const retPolicy = unsetPolicyFeaturesAccordingToLicenseLevel(policy, Gold); + + expect(retPolicy.windows.advanced?.rollback).toEqual(defaults.windows.advanced?.rollback); + + // Preserves non-license gated advanced settings. + expect(retPolicy.windows.advanced?.another_advanced).toEqual(true); + }); + it('sets ransomware supported field to false when license is below Platinum', () => { const defaults = policyFactoryWithoutPaidFeatures(); // reference const policy = policyFactory(); // what we will modify, and should be reset diff --git a/x-pack/plugins/security_solution/common/license/policy_config.ts b/x-pack/plugins/security_solution/common/license/policy_config.ts index 7827722c410b3..0ac19a448c4e4 100644 --- a/x-pack/plugins/security_solution/common/license/policy_config.ts +++ b/x-pack/plugins/security_solution/common/license/policy_config.ts @@ -202,6 +202,22 @@ function isEndpointBehaviorPolicyValidForLicense(policy: PolicyConfig, license: return true; } +function isEndpointAdvancedPolicyValidForLicense(policy: PolicyConfig, license: ILicense | null) { + if (isAtLeast(license, 'platinum')) { + // platinum allows all advanced features + return true; + } + + const defaults = policyFactoryWithoutPaidFeatures(); + + // only platinum or higher may use rollback + if (policy.windows.advanced?.rollback !== defaults.windows.advanced?.rollback) { + return false; + } + + return true; +} + /** * Given an endpoint package policy, verifies that all enabled features that * require a certain license level have a valid license for them. @@ -214,7 +230,8 @@ export const isEndpointPolicyValidForLicense = ( isEndpointMalwarePolicyValidForLicense(policy, license) && isEndpointRansomwarePolicyValidForLicense(policy, license) && isEndpointMemoryPolicyValidForLicense(policy, license) && - isEndpointBehaviorPolicyValidForLicense(policy, license) + isEndpointBehaviorPolicyValidForLicense(policy, license) && + isEndpointAdvancedPolicyValidForLicense(policy, license) ); }; diff --git a/x-pack/plugins/security_solution/common/types/timeline/index.ts b/x-pack/plugins/security_solution/common/types/timeline/index.ts index 3d4d1b5dc28cb..9b1405b78a57d 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/index.ts +++ b/x-pack/plugins/security_solution/common/types/timeline/index.ts @@ -327,6 +327,7 @@ export enum TimelineId { test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', rulePreview = 'rule-preview', + kubernetesPageSessions = 'kubernetes-page-sessions', } export const TimelineIdLiteralRt = runtimeTypes.union([ @@ -341,6 +342,7 @@ export const TimelineIdLiteralRt = runtimeTypes.union([ runtimeTypes.literal(TimelineId.active), runtimeTypes.literal(TimelineId.test), runtimeTypes.literal(TimelineId.rulePreview), + runtimeTypes.literal(TimelineId.kubernetesPageSessions), ]); export type TimelineIdLiteral = runtimeTypes.TypeOf; diff --git a/x-pack/plugins/security_solution/public/common/components/authentication/__snapshots__/authentications_host_table.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/authentication/__snapshots__/authentications_host_table.test.tsx.snap index 84b90a910574f..3b362a2626315 100644 --- a/x-pack/plugins/security_solution/public/common/components/authentication/__snapshots__/authentications_host_table.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/authentication/__snapshots__/authentications_host_table.test.tsx.snap @@ -57,7 +57,7 @@ exports[`Authentication Host Table Component rendering it renders the host authe }
(({ width }) => { font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; font-weight: ${({ theme }) => theme.eui.euiFontWeightSemiBold}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; `; Field.displayName = 'Field'; diff --git a/x-pack/plugins/security_solution/public/common/components/endpoint/__snapshots__/link_to_app.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/endpoint/__snapshots__/link_to_app.test.tsx.snap index 6ff2142c9d151..3399fa3ad8b40 100644 --- a/x-pack/plugins/security_solution/public/common/components/endpoint/__snapshots__/link_to_app.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/endpoint/__snapshots__/link_to_app.test.tsx.snap @@ -35,56 +35,56 @@ exports[`LinkToApp component should render with href 1`] = ` data-s="" > - .css-102pf9n-euiLink-primary{font-weight:500;text-align:left;-webkit-user-select:text;-moz-user-select:text;-ms-user-select:text;user-select:text;color:#006bb8;}/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBcUZhIiwiZmlsZSI6Ii4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IEVsYXN0aWNzZWFyY2ggQi5WLiBhbmQvb3IgbGljZW5zZWQgdG8gRWxhc3RpY3NlYXJjaCBCLlYuIHVuZGVyIG9uZVxuICogb3IgbW9yZSBjb250cmlidXRvciBsaWNlbnNlIGFncmVlbWVudHMuIExpY2Vuc2VkIHVuZGVyIHRoZSBFbGFzdGljIExpY2Vuc2VcbiAqIDIuMCBhbmQgdGhlIFNlcnZlciBTaWRlIFB1YmxpYyBMaWNlbnNlLCB2IDE7IHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0XG4gKiBpbiBjb21wbGlhbmNlIHdpdGgsIGF0IHlvdXIgZWxlY3Rpb24sIHRoZSBFbGFzdGljIExpY2Vuc2UgMi4wIG9yIHRoZSBTZXJ2ZXJcbiAqIFNpZGUgUHVibGljIExpY2Vuc2UsIHYgMS5cbiAqL1xuXG5pbXBvcnQgeyBjc3MgfSBmcm9tICdAZW1vdGlvbi9yZWFjdCc7XG5pbXBvcnQgeyBVc2VFdWlUaGVtZSB9IGZyb20gJy4uLy4uL3NlcnZpY2VzJztcbmltcG9ydCB7IGV1aUZvY3VzUmluZywgbG9naWNhbENTUyB9IGZyb20gJy4uLy4uL2dsb2JhbF9zdHlsaW5nJztcblxuY29uc3QgX2NvbG9yQ1NTID0gKGNvbG9yOiBzdHJpbmcpID0+IHtcbiAgcmV0dXJuIGBcbiAgICBjb2xvcjogJHtjb2xvcn07XG5cbiAgICAmOmhvdmVyLFxuICAgICY6Zm9jdXMsXG4gICAgJjp0YXJnZXQge1xuICAgICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgfVxuXG4gICAgJjp0YXJnZXQge1xuICAgICAgY29sb3I6IGRhcmtlbigke2NvbG9yfSwgMTAlKTtcbiAgICB9XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0hvdmVyQ1NTID0gKCkgPT4ge1xuICByZXR1cm4gYFxuICAgIHRleHQtZGVjb3JhdGlvbjogdW5kZXJsaW5lO1xuICBgO1xufTtcblxuZXhwb3J0IGNvbnN0IGV1aUxpbmtGb2N1c0NTUyA9ICh7IGV1aVRoZW1lIH06IFVzZUV1aVRoZW1lKSA9PiB7XG4gIHJldHVybiBgXG4gICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgdGV4dC1kZWNvcmF0aW9uLXRoaWNrbmVzczogJHtldWlUaGVtZS5ib3JkZXIud2lkdGgudGhpY2t9ICFpbXBvcnRhbnQ7XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0NTUyA9IChfdGhlbWU6IFVzZUV1aVRoZW1lKSA9PiB7XG4gIGNvbnN0IHsgZXVpVGhlbWUgfSA9IF90aGVtZTtcblxuICByZXR1cm4gYFxuICAgIGZvbnQtd2VpZ2h0OiAke2V1aVRoZW1lLmZvbnQud2VpZ2h0Lm1lZGl1bX07XG4gICAgdGV4dC1hbGlnbjogbGVmdDtcblxuICAgICY6aG92ZXIge1xuICAgICAgJHtldWlMaW5rSG92ZXJDU1MoKX1cbiAgICB9XG5cbiAgICAmOmZvY3VzIHtcbiAgICAgICR7ZXVpRm9jdXNSaW5nKGV1aVRoZW1lLCAnb3V0c2V0Jyl9XG4gICAgICAke2V1aUxpbmtGb2N1c0NTUyhfdGhlbWUpfVxuICAgIH1cbiAgYDtcbn07XG5cbmV4cG9ydCBjb25zdCBldWlMaW5rU3R5bGVzID0gKF90aGVtZTogVXNlRXVpVGhlbWUpID0+IHtcbiAgY29uc3QgeyBldWlUaGVtZSB9ID0gX3RoZW1lO1xuXG4gIHJldHVybiB7XG4gICAgZXVpTGluazogY3NzYFxuICAgICAgJHtldWlMaW5rQ1NTKF90aGVtZSl9XG4gICAgICB1c2VyLXNlbGVjdDogdGV4dDtcblxuICAgICAgJlt0YXJnZXQ9J19ibGFuayddIHtcbiAgICAgICAgcG9zaXRpb246IHJlbGF0aXZlO1xuICAgICAgfVxuICAgIGAsXG4gICAgZGlzYWJsZWQ6IGNzc2BcbiAgICAgIGZvbnQtd2VpZ2h0OiBpbmhlcml0O1xuXG4gICAgICAmOmhvdmVyIHtcbiAgICAgICAgY3Vyc29yOiBhdXRvO1xuICAgICAgfVxuXG4gICAgICAmOmhvdmVyLFxuICAgICAgJjpmb2N1cyxcbiAgICAgICY6dGFyZ2V0IHtcbiAgICAgICAgdGV4dC1kZWNvcmF0aW9uOiBub25lO1xuICAgICAgfVxuICAgIGAsXG4gICAgLy8gQ29sb3Igc3R5bGVzXG4gICAgcHJpbWFyeTogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMucHJpbWFyeVRleHQpKSxcbiAgICBzdWJkdWVkOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5zdWJkdWVkKSksXG4gICAgc3VjY2VzczogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMuc3VjY2Vzc1RleHQpKSxcbiAgICBhY2NlbnQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmFjY2VudFRleHQpKSxcbiAgICBkYW5nZXI6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmRhbmdlclRleHQpKSxcbiAgICB3YXJuaW5nOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy53YXJuaW5nVGV4dCkpLFxuICAgIGdob3N0OiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5naG9zdCkpLFxuICAgIHRleHQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLnRleHQpKSxcblxuICAgIC8vIENoaWxkcmVuXG4gICAgZXVpTGlua19fc2NyZWVuUmVhZGVyVGV4dDogY3NzYFxuICAgICAgJHtsb2dpY2FsQ1NTKCdsZWZ0JywgJzBweCcpfVxuICAgIGAsXG4gICAgZXVpTGlua19fZXh0ZXJuYWxJY29uOiBjc3NgXG4gICAgICAke2xvZ2ljYWxDU1MoJ21hcmdpbi1sZWZ0JywgZXVpVGhlbWUuc2l6ZS54cyl9XG4gICAgYCxcbiAgfTtcbn07XG4iXX0= */ + .css-102pf9n-euiLink-primary{font-weight:500;text-align:left;-webkit-user-select:text;-moz-user-select:text;-ms-user-select:text;user-select:text;color:#006bb8;} , , , , , , , , ], }, @@ -165,7 +165,7 @@ exports[`LinkToApp component should render with href 1`] = ` isStringTag={true} serialized={ Object { - "map": "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBcUZhIiwiZmlsZSI6Ii4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IEVsYXN0aWNzZWFyY2ggQi5WLiBhbmQvb3IgbGljZW5zZWQgdG8gRWxhc3RpY3NlYXJjaCBCLlYuIHVuZGVyIG9uZVxuICogb3IgbW9yZSBjb250cmlidXRvciBsaWNlbnNlIGFncmVlbWVudHMuIExpY2Vuc2VkIHVuZGVyIHRoZSBFbGFzdGljIExpY2Vuc2VcbiAqIDIuMCBhbmQgdGhlIFNlcnZlciBTaWRlIFB1YmxpYyBMaWNlbnNlLCB2IDE7IHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0XG4gKiBpbiBjb21wbGlhbmNlIHdpdGgsIGF0IHlvdXIgZWxlY3Rpb24sIHRoZSBFbGFzdGljIExpY2Vuc2UgMi4wIG9yIHRoZSBTZXJ2ZXJcbiAqIFNpZGUgUHVibGljIExpY2Vuc2UsIHYgMS5cbiAqL1xuXG5pbXBvcnQgeyBjc3MgfSBmcm9tICdAZW1vdGlvbi9yZWFjdCc7XG5pbXBvcnQgeyBVc2VFdWlUaGVtZSB9IGZyb20gJy4uLy4uL3NlcnZpY2VzJztcbmltcG9ydCB7IGV1aUZvY3VzUmluZywgbG9naWNhbENTUyB9IGZyb20gJy4uLy4uL2dsb2JhbF9zdHlsaW5nJztcblxuY29uc3QgX2NvbG9yQ1NTID0gKGNvbG9yOiBzdHJpbmcpID0+IHtcbiAgcmV0dXJuIGBcbiAgICBjb2xvcjogJHtjb2xvcn07XG5cbiAgICAmOmhvdmVyLFxuICAgICY6Zm9jdXMsXG4gICAgJjp0YXJnZXQge1xuICAgICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgfVxuXG4gICAgJjp0YXJnZXQge1xuICAgICAgY29sb3I6IGRhcmtlbigke2NvbG9yfSwgMTAlKTtcbiAgICB9XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0hvdmVyQ1NTID0gKCkgPT4ge1xuICByZXR1cm4gYFxuICAgIHRleHQtZGVjb3JhdGlvbjogdW5kZXJsaW5lO1xuICBgO1xufTtcblxuZXhwb3J0IGNvbnN0IGV1aUxpbmtGb2N1c0NTUyA9ICh7IGV1aVRoZW1lIH06IFVzZUV1aVRoZW1lKSA9PiB7XG4gIHJldHVybiBgXG4gICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgdGV4dC1kZWNvcmF0aW9uLXRoaWNrbmVzczogJHtldWlUaGVtZS5ib3JkZXIud2lkdGgudGhpY2t9ICFpbXBvcnRhbnQ7XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0NTUyA9IChfdGhlbWU6IFVzZUV1aVRoZW1lKSA9PiB7XG4gIGNvbnN0IHsgZXVpVGhlbWUgfSA9IF90aGVtZTtcblxuICByZXR1cm4gYFxuICAgIGZvbnQtd2VpZ2h0OiAke2V1aVRoZW1lLmZvbnQud2VpZ2h0Lm1lZGl1bX07XG4gICAgdGV4dC1hbGlnbjogbGVmdDtcblxuICAgICY6aG92ZXIge1xuICAgICAgJHtldWlMaW5rSG92ZXJDU1MoKX1cbiAgICB9XG5cbiAgICAmOmZvY3VzIHtcbiAgICAgICR7ZXVpRm9jdXNSaW5nKGV1aVRoZW1lLCAnb3V0c2V0Jyl9XG4gICAgICAke2V1aUxpbmtGb2N1c0NTUyhfdGhlbWUpfVxuICAgIH1cbiAgYDtcbn07XG5cbmV4cG9ydCBjb25zdCBldWlMaW5rU3R5bGVzID0gKF90aGVtZTogVXNlRXVpVGhlbWUpID0+IHtcbiAgY29uc3QgeyBldWlUaGVtZSB9ID0gX3RoZW1lO1xuXG4gIHJldHVybiB7XG4gICAgZXVpTGluazogY3NzYFxuICAgICAgJHtldWlMaW5rQ1NTKF90aGVtZSl9XG4gICAgICB1c2VyLXNlbGVjdDogdGV4dDtcblxuICAgICAgJlt0YXJnZXQ9J19ibGFuayddIHtcbiAgICAgICAgcG9zaXRpb246IHJlbGF0aXZlO1xuICAgICAgfVxuICAgIGAsXG4gICAgZGlzYWJsZWQ6IGNzc2BcbiAgICAgIGZvbnQtd2VpZ2h0OiBpbmhlcml0O1xuXG4gICAgICAmOmhvdmVyIHtcbiAgICAgICAgY3Vyc29yOiBhdXRvO1xuICAgICAgfVxuXG4gICAgICAmOmhvdmVyLFxuICAgICAgJjpmb2N1cyxcbiAgICAgICY6dGFyZ2V0IHtcbiAgICAgICAgdGV4dC1kZWNvcmF0aW9uOiBub25lO1xuICAgICAgfVxuICAgIGAsXG4gICAgLy8gQ29sb3Igc3R5bGVzXG4gICAgcHJpbWFyeTogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMucHJpbWFyeVRleHQpKSxcbiAgICBzdWJkdWVkOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5zdWJkdWVkKSksXG4gICAgc3VjY2VzczogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMuc3VjY2Vzc1RleHQpKSxcbiAgICBhY2NlbnQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmFjY2VudFRleHQpKSxcbiAgICBkYW5nZXI6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmRhbmdlclRleHQpKSxcbiAgICB3YXJuaW5nOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy53YXJuaW5nVGV4dCkpLFxuICAgIGdob3N0OiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5naG9zdCkpLFxuICAgIHRleHQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLnRleHQpKSxcblxuICAgIC8vIENoaWxkcmVuXG4gICAgZXVpTGlua19fc2NyZWVuUmVhZGVyVGV4dDogY3NzYFxuICAgICAgJHtsb2dpY2FsQ1NTKCdsZWZ0JywgJzBweCcpfVxuICAgIGAsXG4gICAgZXVpTGlua19fZXh0ZXJuYWxJY29uOiBjc3NgXG4gICAgICAke2xvZ2ljYWxDU1MoJ21hcmdpbi1sZWZ0JywgZXVpVGhlbWUuc2l6ZS54cyl9XG4gICAgYCxcbiAgfTtcbn07XG4iXX0= */", + "map": undefined, "name": "102pf9n-euiLink-primary", "next": undefined, "styles": " @@ -261,56 +261,56 @@ exports[`LinkToApp component should render with minimum input 1`] = ` data-s="" > - .css-102pf9n-euiLink-primary{font-weight:500;text-align:left;-webkit-user-select:text;-moz-user-select:text;-ms-user-select:text;user-select:text;color:#006bb8;}/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBcUZhIiwiZmlsZSI6Ii4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IEVsYXN0aWNzZWFyY2ggQi5WLiBhbmQvb3IgbGljZW5zZWQgdG8gRWxhc3RpY3NlYXJjaCBCLlYuIHVuZGVyIG9uZVxuICogb3IgbW9yZSBjb250cmlidXRvciBsaWNlbnNlIGFncmVlbWVudHMuIExpY2Vuc2VkIHVuZGVyIHRoZSBFbGFzdGljIExpY2Vuc2VcbiAqIDIuMCBhbmQgdGhlIFNlcnZlciBTaWRlIFB1YmxpYyBMaWNlbnNlLCB2IDE7IHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0XG4gKiBpbiBjb21wbGlhbmNlIHdpdGgsIGF0IHlvdXIgZWxlY3Rpb24sIHRoZSBFbGFzdGljIExpY2Vuc2UgMi4wIG9yIHRoZSBTZXJ2ZXJcbiAqIFNpZGUgUHVibGljIExpY2Vuc2UsIHYgMS5cbiAqL1xuXG5pbXBvcnQgeyBjc3MgfSBmcm9tICdAZW1vdGlvbi9yZWFjdCc7XG5pbXBvcnQgeyBVc2VFdWlUaGVtZSB9IGZyb20gJy4uLy4uL3NlcnZpY2VzJztcbmltcG9ydCB7IGV1aUZvY3VzUmluZywgbG9naWNhbENTUyB9IGZyb20gJy4uLy4uL2dsb2JhbF9zdHlsaW5nJztcblxuY29uc3QgX2NvbG9yQ1NTID0gKGNvbG9yOiBzdHJpbmcpID0+IHtcbiAgcmV0dXJuIGBcbiAgICBjb2xvcjogJHtjb2xvcn07XG5cbiAgICAmOmhvdmVyLFxuICAgICY6Zm9jdXMsXG4gICAgJjp0YXJnZXQge1xuICAgICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgfVxuXG4gICAgJjp0YXJnZXQge1xuICAgICAgY29sb3I6IGRhcmtlbigke2NvbG9yfSwgMTAlKTtcbiAgICB9XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0hvdmVyQ1NTID0gKCkgPT4ge1xuICByZXR1cm4gYFxuICAgIHRleHQtZGVjb3JhdGlvbjogdW5kZXJsaW5lO1xuICBgO1xufTtcblxuZXhwb3J0IGNvbnN0IGV1aUxpbmtGb2N1c0NTUyA9ICh7IGV1aVRoZW1lIH06IFVzZUV1aVRoZW1lKSA9PiB7XG4gIHJldHVybiBgXG4gICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgdGV4dC1kZWNvcmF0aW9uLXRoaWNrbmVzczogJHtldWlUaGVtZS5ib3JkZXIud2lkdGgudGhpY2t9ICFpbXBvcnRhbnQ7XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0NTUyA9IChfdGhlbWU6IFVzZUV1aVRoZW1lKSA9PiB7XG4gIGNvbnN0IHsgZXVpVGhlbWUgfSA9IF90aGVtZTtcblxuICByZXR1cm4gYFxuICAgIGZvbnQtd2VpZ2h0OiAke2V1aVRoZW1lLmZvbnQud2VpZ2h0Lm1lZGl1bX07XG4gICAgdGV4dC1hbGlnbjogbGVmdDtcblxuICAgICY6aG92ZXIge1xuICAgICAgJHtldWlMaW5rSG92ZXJDU1MoKX1cbiAgICB9XG5cbiAgICAmOmZvY3VzIHtcbiAgICAgICR7ZXVpRm9jdXNSaW5nKGV1aVRoZW1lLCAnb3V0c2V0Jyl9XG4gICAgICAke2V1aUxpbmtGb2N1c0NTUyhfdGhlbWUpfVxuICAgIH1cbiAgYDtcbn07XG5cbmV4cG9ydCBjb25zdCBldWlMaW5rU3R5bGVzID0gKF90aGVtZTogVXNlRXVpVGhlbWUpID0+IHtcbiAgY29uc3QgeyBldWlUaGVtZSB9ID0gX3RoZW1lO1xuXG4gIHJldHVybiB7XG4gICAgZXVpTGluazogY3NzYFxuICAgICAgJHtldWlMaW5rQ1NTKF90aGVtZSl9XG4gICAgICB1c2VyLXNlbGVjdDogdGV4dDtcblxuICAgICAgJlt0YXJnZXQ9J19ibGFuayddIHtcbiAgICAgICAgcG9zaXRpb246IHJlbGF0aXZlO1xuICAgICAgfVxuICAgIGAsXG4gICAgZGlzYWJsZWQ6IGNzc2BcbiAgICAgIGZvbnQtd2VpZ2h0OiBpbmhlcml0O1xuXG4gICAgICAmOmhvdmVyIHtcbiAgICAgICAgY3Vyc29yOiBhdXRvO1xuICAgICAgfVxuXG4gICAgICAmOmhvdmVyLFxuICAgICAgJjpmb2N1cyxcbiAgICAgICY6dGFyZ2V0IHtcbiAgICAgICAgdGV4dC1kZWNvcmF0aW9uOiBub25lO1xuICAgICAgfVxuICAgIGAsXG4gICAgLy8gQ29sb3Igc3R5bGVzXG4gICAgcHJpbWFyeTogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMucHJpbWFyeVRleHQpKSxcbiAgICBzdWJkdWVkOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5zdWJkdWVkKSksXG4gICAgc3VjY2VzczogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMuc3VjY2Vzc1RleHQpKSxcbiAgICBhY2NlbnQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmFjY2VudFRleHQpKSxcbiAgICBkYW5nZXI6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmRhbmdlclRleHQpKSxcbiAgICB3YXJuaW5nOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy53YXJuaW5nVGV4dCkpLFxuICAgIGdob3N0OiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5naG9zdCkpLFxuICAgIHRleHQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLnRleHQpKSxcblxuICAgIC8vIENoaWxkcmVuXG4gICAgZXVpTGlua19fc2NyZWVuUmVhZGVyVGV4dDogY3NzYFxuICAgICAgJHtsb2dpY2FsQ1NTKCdsZWZ0JywgJzBweCcpfVxuICAgIGAsXG4gICAgZXVpTGlua19fZXh0ZXJuYWxJY29uOiBjc3NgXG4gICAgICAke2xvZ2ljYWxDU1MoJ21hcmdpbi1sZWZ0JywgZXVpVGhlbWUuc2l6ZS54cyl9XG4gICAgYCxcbiAgfTtcbn07XG4iXX0= */ + .css-102pf9n-euiLink-primary{font-weight:500;text-align:left;-webkit-user-select:text;-moz-user-select:text;-ms-user-select:text;user-select:text;color:#006bb8;} , , , , , , , , ], }, @@ -387,7 +387,7 @@ exports[`LinkToApp component should render with minimum input 1`] = ` isStringTag={true} serialized={ Object { - "map": "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBcUZhIiwiZmlsZSI6Ii4uLy4uLy4uL3NyYy9jb21wb25lbnRzL2xpbmsvbGluay5zdHlsZXMudHMiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IEVsYXN0aWNzZWFyY2ggQi5WLiBhbmQvb3IgbGljZW5zZWQgdG8gRWxhc3RpY3NlYXJjaCBCLlYuIHVuZGVyIG9uZVxuICogb3IgbW9yZSBjb250cmlidXRvciBsaWNlbnNlIGFncmVlbWVudHMuIExpY2Vuc2VkIHVuZGVyIHRoZSBFbGFzdGljIExpY2Vuc2VcbiAqIDIuMCBhbmQgdGhlIFNlcnZlciBTaWRlIFB1YmxpYyBMaWNlbnNlLCB2IDE7IHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0XG4gKiBpbiBjb21wbGlhbmNlIHdpdGgsIGF0IHlvdXIgZWxlY3Rpb24sIHRoZSBFbGFzdGljIExpY2Vuc2UgMi4wIG9yIHRoZSBTZXJ2ZXJcbiAqIFNpZGUgUHVibGljIExpY2Vuc2UsIHYgMS5cbiAqL1xuXG5pbXBvcnQgeyBjc3MgfSBmcm9tICdAZW1vdGlvbi9yZWFjdCc7XG5pbXBvcnQgeyBVc2VFdWlUaGVtZSB9IGZyb20gJy4uLy4uL3NlcnZpY2VzJztcbmltcG9ydCB7IGV1aUZvY3VzUmluZywgbG9naWNhbENTUyB9IGZyb20gJy4uLy4uL2dsb2JhbF9zdHlsaW5nJztcblxuY29uc3QgX2NvbG9yQ1NTID0gKGNvbG9yOiBzdHJpbmcpID0+IHtcbiAgcmV0dXJuIGBcbiAgICBjb2xvcjogJHtjb2xvcn07XG5cbiAgICAmOmhvdmVyLFxuICAgICY6Zm9jdXMsXG4gICAgJjp0YXJnZXQge1xuICAgICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgfVxuXG4gICAgJjp0YXJnZXQge1xuICAgICAgY29sb3I6IGRhcmtlbigke2NvbG9yfSwgMTAlKTtcbiAgICB9XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0hvdmVyQ1NTID0gKCkgPT4ge1xuICByZXR1cm4gYFxuICAgIHRleHQtZGVjb3JhdGlvbjogdW5kZXJsaW5lO1xuICBgO1xufTtcblxuZXhwb3J0IGNvbnN0IGV1aUxpbmtGb2N1c0NTUyA9ICh7IGV1aVRoZW1lIH06IFVzZUV1aVRoZW1lKSA9PiB7XG4gIHJldHVybiBgXG4gICAgdGV4dC1kZWNvcmF0aW9uOiB1bmRlcmxpbmU7XG4gICAgdGV4dC1kZWNvcmF0aW9uLXRoaWNrbmVzczogJHtldWlUaGVtZS5ib3JkZXIud2lkdGgudGhpY2t9ICFpbXBvcnRhbnQ7XG4gIGA7XG59O1xuXG5leHBvcnQgY29uc3QgZXVpTGlua0NTUyA9IChfdGhlbWU6IFVzZUV1aVRoZW1lKSA9PiB7XG4gIGNvbnN0IHsgZXVpVGhlbWUgfSA9IF90aGVtZTtcblxuICByZXR1cm4gYFxuICAgIGZvbnQtd2VpZ2h0OiAke2V1aVRoZW1lLmZvbnQud2VpZ2h0Lm1lZGl1bX07XG4gICAgdGV4dC1hbGlnbjogbGVmdDtcblxuICAgICY6aG92ZXIge1xuICAgICAgJHtldWlMaW5rSG92ZXJDU1MoKX1cbiAgICB9XG5cbiAgICAmOmZvY3VzIHtcbiAgICAgICR7ZXVpRm9jdXNSaW5nKGV1aVRoZW1lLCAnb3V0c2V0Jyl9XG4gICAgICAke2V1aUxpbmtGb2N1c0NTUyhfdGhlbWUpfVxuICAgIH1cbiAgYDtcbn07XG5cbmV4cG9ydCBjb25zdCBldWlMaW5rU3R5bGVzID0gKF90aGVtZTogVXNlRXVpVGhlbWUpID0+IHtcbiAgY29uc3QgeyBldWlUaGVtZSB9ID0gX3RoZW1lO1xuXG4gIHJldHVybiB7XG4gICAgZXVpTGluazogY3NzYFxuICAgICAgJHtldWlMaW5rQ1NTKF90aGVtZSl9XG4gICAgICB1c2VyLXNlbGVjdDogdGV4dDtcblxuICAgICAgJlt0YXJnZXQ9J19ibGFuayddIHtcbiAgICAgICAgcG9zaXRpb246IHJlbGF0aXZlO1xuICAgICAgfVxuICAgIGAsXG4gICAgZGlzYWJsZWQ6IGNzc2BcbiAgICAgIGZvbnQtd2VpZ2h0OiBpbmhlcml0O1xuXG4gICAgICAmOmhvdmVyIHtcbiAgICAgICAgY3Vyc29yOiBhdXRvO1xuICAgICAgfVxuXG4gICAgICAmOmhvdmVyLFxuICAgICAgJjpmb2N1cyxcbiAgICAgICY6dGFyZ2V0IHtcbiAgICAgICAgdGV4dC1kZWNvcmF0aW9uOiBub25lO1xuICAgICAgfVxuICAgIGAsXG4gICAgLy8gQ29sb3Igc3R5bGVzXG4gICAgcHJpbWFyeTogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMucHJpbWFyeVRleHQpKSxcbiAgICBzdWJkdWVkOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5zdWJkdWVkKSksXG4gICAgc3VjY2VzczogY3NzKF9jb2xvckNTUyhldWlUaGVtZS5jb2xvcnMuc3VjY2Vzc1RleHQpKSxcbiAgICBhY2NlbnQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmFjY2VudFRleHQpKSxcbiAgICBkYW5nZXI6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLmRhbmdlclRleHQpKSxcbiAgICB3YXJuaW5nOiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy53YXJuaW5nVGV4dCkpLFxuICAgIGdob3N0OiBjc3MoX2NvbG9yQ1NTKGV1aVRoZW1lLmNvbG9ycy5naG9zdCkpLFxuICAgIHRleHQ6IGNzcyhfY29sb3JDU1MoZXVpVGhlbWUuY29sb3JzLnRleHQpKSxcblxuICAgIC8vIENoaWxkcmVuXG4gICAgZXVpTGlua19fc2NyZWVuUmVhZGVyVGV4dDogY3NzYFxuICAgICAgJHtsb2dpY2FsQ1NTKCdsZWZ0JywgJzBweCcpfVxuICAgIGAsXG4gICAgZXVpTGlua19fZXh0ZXJuYWxJY29uOiBjc3NgXG4gICAgICAke2xvZ2ljYWxDU1MoJ21hcmdpbi1sZWZ0JywgZXVpVGhlbWUuc2l6ZS54cyl9XG4gICAgYCxcbiAgfTtcbn07XG4iXX0= */", + "map": undefined, "name": "102pf9n-euiLink-primary", "next": undefined, "styles": " diff --git a/x-pack/plugins/security_solution/public/common/components/endpoint/host_isolation/endpoint_host_isolation_status.test.tsx b/x-pack/plugins/security_solution/public/common/components/endpoint/host_isolation/endpoint_host_isolation_status.test.tsx index 72b7e987436ba..8ed591d96fd4b 100644 --- a/x-pack/plugins/security_solution/public/common/components/endpoint/host_isolation/endpoint_host_isolation_status.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/endpoint/host_isolation/endpoint_host_isolation_status.test.tsx @@ -53,7 +53,7 @@ describe('when using the EndpointHostIsolationStatus component', () => { const { getByTestId } = render(componentProps); expect(getByTestId('test').textContent).toBe(expectedLabel); // Validate that the text color is set to `subdued` - expect(getByTestId('test-pending').classList.contains('euiTextColor--subdued')).toBe(true); + expect(getByTestId('test-pending').classList.toString().includes('subdued')).toBe(true); }); describe('and the disableIsolationUIPendingStatuses experimental feature flag is true', () => { diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_accordion_group.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_accordion_group.tsx index a727c6e5ce72d..a88e47690dd51 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_accordion_group.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_accordion_group.tsx @@ -36,10 +36,10 @@ import { getFirstElement } from '../../../../../common/utils/data_retrieval'; const StyledEuiAccordion = styled(EuiAccordion)` .euiAccordion__triggerWrapper { background: ${({ theme }) => theme.eui.euiColorLightestShade}; - border-radius: ${({ theme }) => theme.eui.paddingSizes.xs}; - height: ${({ theme }) => theme.eui.paddingSizes.xl}; - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; - padding-left: ${({ theme }) => theme.eui.paddingSizes.s}; + border-radius: ${({ theme }) => theme.eui.euiSizeXS}; + height: ${({ theme }) => theme.eui.euiSizeXL}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; + padding-left: ${({ theme }) => theme.eui.euiSizeS}; } `; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap index 3a689b1faa0cc..d87c888646e89 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap @@ -89,10 +89,10 @@ exports[`Event Details Overview Cards renders rows and spacers correctly 1`] = ` class="euiFlexItem" >
Status
@@ -186,10 +186,10 @@ exports[`Event Details Overview Cards renders rows and spacers correctly 1`] = ` class="euiFlexItem" >
Risk Score
@@ -262,10 +262,10 @@ exports[`Event Details Overview Cards renders rows and spacers correctly 1`] = ` class="euiFlexItem" >
Rule
diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/overview/overview_card.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/overview/overview_card.tsx index 7984c23a337de..6b46d6985202e 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/overview/overview_card.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/overview/overview_card.tsx @@ -16,7 +16,7 @@ const ActionWrapper = euiStyled.div` width: 0; transform: translate(6px); transition: transform 50ms ease-in-out; - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; `; const OverviewPanel = euiStyled(EuiPanel)<{ @@ -24,7 +24,7 @@ const OverviewPanel = euiStyled(EuiPanel)<{ }>` &&& { background-color: ${({ theme }) => theme.eui.euiColorLightestShade}; - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; height: 78px; } diff --git a/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx b/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx index 8cc9a6a43c895..4687aa1a67807 100644 --- a/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx +++ b/x-pack/plugins/security_solution/public/common/components/exceptions/add_exception_comments.tsx @@ -32,7 +32,7 @@ const COMMENT_ACCORDION_BUTTON_CLASS_NAME = 'exceptionCommentAccordionButton'; const MyAvatar = styled(EuiAvatar)` ${({ theme }) => css` - margin-right: ${theme.eui.paddingSizes.s}; + margin-right: ${theme.eui.euiSizeS}; `} `; @@ -40,7 +40,7 @@ const CommentAccordion = styled(EuiAccordion)` ${({ theme }) => css` .${COMMENT_ACCORDION_BUTTON_CLASS_NAME} { color: ${theme.eui.euiColorPrimary}; - padding: ${theme.eui.paddingSizes.m} 0; + padding: ${theme.eui.euiSizeM} 0; } `} `; diff --git a/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_flyout/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_flyout/index.test.tsx index 12d322fd03008..b7e8de53761aa 100644 --- a/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_flyout/index.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/exceptions/edit_exception_flyout/index.test.tsx @@ -31,9 +31,7 @@ const mockTheme = getMockTheme({ euiBreakpoints: { l: '1200px', }, - paddingSizes: { - m: '10px', - }, + euiSizeM: '10px', }, }); diff --git a/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_utility.test.tsx b/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_utility.test.tsx index 562c6a7250a5d..f600fe28f3ecb 100644 --- a/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_utility.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/exceptions_utility.test.tsx @@ -17,9 +17,7 @@ const mockTheme = getMockTheme({ euiBreakpoints: { l: '1200px', }, - paddingSizes: { - m: '10px', - }, + euiSizeM: '10px', euiBorderThin: '1px solid #ece', }, }); diff --git a/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx index 473d494da38be..eeab8c7e36b70 100644 --- a/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/exceptions/viewer/index.test.tsx @@ -24,9 +24,7 @@ const mockTheme = getMockTheme({ euiBreakpoints: { l: '1200px', }, - paddingSizes: { - m: '10px', - }, + euiSizeM: '10px', }, }); diff --git a/x-pack/plugins/security_solution/public/common/components/exit_full_screen/index.tsx b/x-pack/plugins/security_solution/public/common/components/exit_full_screen/index.tsx index 5ae537128bee6..ee47fca53543b 100644 --- a/x-pack/plugins/security_solution/public/common/components/exit_full_screen/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/exit_full_screen/index.tsx @@ -14,7 +14,7 @@ import * as i18n from './translations'; export const EXIT_FULL_SCREEN_CLASS_NAME = 'exit-full-screen'; const StyledEuiButton = styled(EuiButton)` - margin: ${({ theme }) => theme.eui.paddingSizes.s}; + margin: ${({ theme }) => theme.eui.euiSizeS}; `; interface Props { diff --git a/x-pack/plugins/security_solution/public/common/components/header_page/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/header_page/index.test.tsx index 84843e8be90ed..eef91978bba2d 100644 --- a/x-pack/plugins/security_solution/public/common/components/header_page/index.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/header_page/index.test.tsx @@ -136,9 +136,6 @@ describe('HeaderPage', () => { 'border-bottom', euiDarkVars.euiBorderThin ); - expect(securitySolutionHeaderPage).not.toHaveStyleRule( - 'padding-bottom', - euiDarkVars.paddingSizes.l - ); + expect(securitySolutionHeaderPage).not.toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeL); }); }); diff --git a/x-pack/plugins/security_solution/public/common/components/header_section/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/header_section/index.test.tsx index d835f4b2b236a..d026e3c15ea35 100644 --- a/x-pack/plugins/security_solution/public/common/components/header_section/index.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/header_section/index.test.tsx @@ -84,7 +84,7 @@ describe('HeaderSection', () => { const siemHeaderSection = wrapper.find('.siemHeaderSection').first(); expect(siemHeaderSection).toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(siemHeaderSection).toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.l); + expect(siemHeaderSection).toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeL); }); test('it DOES NOT apply border styles when border is false', () => { @@ -96,7 +96,7 @@ describe('HeaderSection', () => { const siemHeaderSection = wrapper.find('.siemHeaderSection').first(); expect(siemHeaderSection).not.toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(siemHeaderSection).not.toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.l); + expect(siemHeaderSection).not.toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeL); }); test('it splits the title and supplement areas evenly when split is true', () => { diff --git a/x-pack/plugins/security_solution/public/common/components/header_section/index.tsx b/x-pack/plugins/security_solution/public/common/components/header_section/index.tsx index ae9006301c084..8fe8439804e26 100644 --- a/x-pack/plugins/security_solution/public/common/components/header_section/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/header_section/index.tsx @@ -51,7 +51,7 @@ const Header = styled.header` border && css` border-bottom: ${({ theme }) => theme.eui.euiBorderThin}; - padding-bottom: ${({ theme }) => theme.eui.paddingSizes.l}; + padding-bottom: ${({ theme }) => theme.eui.euiSizeL}; `} `; Header.displayName = 'Header'; diff --git a/x-pack/plugins/security_solution/public/common/components/hover_actions/index.tsx b/x-pack/plugins/security_solution/public/common/components/hover_actions/index.tsx index 731b4bb85ba42..d61418c95b1ed 100644 --- a/x-pack/plugins/security_solution/public/common/components/hover_actions/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/hover_actions/index.tsx @@ -82,7 +82,7 @@ const StyledHoverActionsContainer = styled.div<{ const StyledHoverActionsContainerWithPaddingsAndMinWidth = styled(StyledHoverActionsContainer)` min-width: ${({ $hideTopN }) => `${$hideTopN ? '112px' : '138px'}`}; - padding: ${(props) => `0 ${props.theme.eui.paddingSizes.s}`}; + padding: ${(props) => `0 ${props.theme.eui.euiSizeS}`}; position: relative; `; diff --git a/x-pack/plugins/security_solution/public/common/components/loader/index.tsx b/x-pack/plugins/security_solution/public/common/components/loader/index.tsx index ac8c253098027..1e2ebcacff862 100644 --- a/x-pack/plugins/security_solution/public/common/components/loader/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/loader/index.tsx @@ -18,7 +18,7 @@ import React from 'react'; import styled, { css } from 'styled-components'; const Aside = styled.aside<{ overlay?: boolean; overlayBackground?: string }>` - padding: ${({ theme }) => theme.eui.paddingSizes.m}; + padding: ${({ theme }) => theme.eui.euiSizeM}; ${({ overlay, overlayBackground, theme }) => overlay && diff --git a/x-pack/plugins/security_solution/public/common/components/paginated_table/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/paginated_table/index.test.tsx index 2ca85d4a3ccb9..0ba5e1569993a 100644 --- a/x-pack/plugins/security_solution/public/common/components/paginated_table/index.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/paginated_table/index.test.tsx @@ -31,9 +31,7 @@ const mockTheme = getMockTheme({ euiBreakpoints: { s: '450px', }, - paddingSizes: { - m: '10px', - }, + euiSizeM: '10px', }, }); diff --git a/x-pack/plugins/security_solution/public/common/components/risk_score_over_time/index.tsx b/x-pack/plugins/security_solution/public/common/components/risk_score_over_time/index.tsx index a7a2dc676abc5..460da806f5433 100644 --- a/x-pack/plugins/security_solution/public/common/components/risk_score_over_time/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/risk_score_over_time/index.tsx @@ -46,7 +46,7 @@ const DEFAULT_CHART_HEIGHT = 250; const StyledEuiText = styled(EuiText)` font-size: 9px; font-weight: ${({ theme }) => theme.eui.euiFontWeightSemiBold}; - margin-right: ${({ theme }) => theme.eui.paddingSizes.xs}; + margin-right: ${({ theme }) => theme.eui.euiSizeXS}; `; const LoadingChart = styled(EuiLoadingChart)` diff --git a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts index 4c045e358e1d6..0e7bdd7d1f540 100644 --- a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts +++ b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts @@ -59,10 +59,13 @@ export const sessionsHeaders: ColumnHeaderOptions[] = [ }, ]; -export const sessionsDefaultModel: SubsetTimelineModel = { +export const getSessionsDefaultModel = ( + columns: ColumnHeaderOptions[], + defaultColumns: ColumnHeaderOptions[] +): SubsetTimelineModel => ({ ...timelineDefaults, - columns: sessionsHeaders, - defaultColumns: sessionsHeaders, + columns, + defaultColumns, excludedRowRendererIds: Object.values(RowRendererId), sort: [ { @@ -71,4 +74,4 @@ export const sessionsDefaultModel: SubsetTimelineModel = { sortDirection: 'desc', }, ], -}; +}); diff --git a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx index 4d89b969e5c17..6d3038e4554ed 100644 --- a/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx @@ -10,7 +10,7 @@ import type { Filter } from '@kbn/es-query'; import { SessionsComponentsProps } from './types'; import { ESBoolQuery } from '../../../../common/typed_json'; import { StatefulEventsViewer } from '../events_viewer'; -import { sessionsDefaultModel } from './default_headers'; +import { getSessionsDefaultModel, sessionsHeaders } from './default_headers'; import { defaultRowRenderers } from '../../../timelines/components/timeline/body/renderers'; import { DefaultCellRenderer } from '../../../timelines/components/timeline/cell_rendering/default_cell_renderer'; import * as i18n from './translations'; @@ -48,6 +48,8 @@ const SessionsViewComponent: React.FC = ({ pageFilters, startDate, filterQuery, + columns = sessionsHeaders, + defaultColumns = sessionsHeaders, }) => { const parsedFilterQuery: ESBoolQuery = useMemo(() => { if (filterQuery && filterQuery !== '') { @@ -83,7 +85,7 @@ const SessionsViewComponent: React.FC = ({
{ timelineId: TimelineIdLiteral; @@ -15,4 +15,6 @@ export interface SessionsComponentsProps extends Pick` ${({ theme, $severity, $hideBackgroundColor }) => css` width: fit-content; - padding-right: ${theme.eui.paddingSizes.s}; - padding-left: ${theme.eui.paddingSizes.xs}; + padding-right: ${theme.eui.euiSizeS}; + padding-left: ${theme.eui.euiSizeXS}; ${($severity === 'Critical' || $severity === 'High') && !$hideBackgroundColor && @@ -38,7 +38,7 @@ const RiskBadge = styled.div<{ $severity: RiskSeverity; $hideBackgroundColor: bo `} `; const TooltipContainer = styled.div` - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; `; export const RiskScore: React.FC<{ severity: RiskSeverity; diff --git a/x-pack/plugins/security_solution/public/common/components/toasters/__snapshots__/modal_all_errors.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/toasters/__snapshots__/modal_all_errors.test.tsx.snap index ee1b371fb5178..a2be42a0289e1 100644 --- a/x-pack/plugins/security_solution/public/common/components/toasters/__snapshots__/modal_all_errors.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/toasters/__snapshots__/modal_all_errors.test.tsx.snap @@ -19,23 +19,17 @@ exports[`Modal all errors rendering it renders the default all errors modal when - Error 1, Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - + x !== TimelineId.active); diff --git a/x-pack/plugins/security_solution/public/common/components/utility_bar/styles.tsx b/x-pack/plugins/security_solution/public/common/components/utility_bar/styles.tsx index c8a71cc43a283..82200b4f7478c 100644 --- a/x-pack/plugins/security_solution/public/common/components/utility_bar/styles.tsx +++ b/x-pack/plugins/security_solution/public/common/components/utility_bar/styles.tsx @@ -30,7 +30,7 @@ export const Bar = styled.aside.attrs({ ${border && css` border-bottom: ${theme.eui.euiBorderThin}; - padding-bottom: ${theme.eui.paddingSizes.s}; + padding-bottom: ${theme.eui.euiSizeS}; `} @media only screen and (min-width: ${theme.eui.euiBreakpoints.l}) { @@ -83,8 +83,8 @@ export const BarGroup = styled.div.attrs({ @media only screen and (min-width: ${theme.eui.euiBreakpoints.m}) { border-right: ${theme.eui.euiBorderThin}; flex-wrap: nowrap; - margin-right: ${theme.eui.paddingSizes.m}; - padding-right: ${theme.eui.paddingSizes.m}; + margin-right: ${theme.eui.euiSizeM}; + padding-right: ${theme.eui.euiSizeM}; & + & { margin-top: 0; diff --git a/x-pack/plugins/security_solution/public/common/components/utility_bar/utility_bar.test.tsx b/x-pack/plugins/security_solution/public/common/components/utility_bar/utility_bar.test.tsx index c5fc48562add6..e753b4ff40560 100644 --- a/x-pack/plugins/security_solution/public/common/components/utility_bar/utility_bar.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/utility_bar/utility_bar.test.tsx @@ -86,7 +86,7 @@ describe('UtilityBar', () => { const siemUtilityBar = wrapper.find('.siemUtilityBar').first(); expect(siemUtilityBar).toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(siemUtilityBar).toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.s); + expect(siemUtilityBar).toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeS); }); test('it DOES NOT apply border styles when border is false', () => { @@ -122,6 +122,6 @@ describe('UtilityBar', () => { const siemUtilityBar = wrapper.find('.siemUtilityBar').first(); expect(siemUtilityBar).not.toHaveStyleRule('border-bottom', euiDarkVars.euiBorderThin); - expect(siemUtilityBar).not.toHaveStyleRule('padding-bottom', euiDarkVars.paddingSizes.s); + expect(siemUtilityBar).not.toHaveStyleRule('padding-bottom', euiDarkVars.euiSizeS); }); }); diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/index.tsx b/x-pack/plugins/security_solution/public/common/components/visualization_actions/index.tsx index e22865c18bd99..420c2e3dd6c78 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/index.tsx @@ -33,7 +33,7 @@ const Wrapper = styled.div` z-index: 1; } &.histogram-viz-actions { - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; } `; diff --git a/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_utility_bar/index.tsx b/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_utility_bar/index.tsx index cba6a3f47f3fc..a2c9ddc27fbb6 100644 --- a/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_utility_bar/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_utility_bar/index.tsx @@ -51,7 +51,7 @@ const UtilityBarFlexGroup = styled(EuiFlexGroup)` `; const AdditionalFiltersItem = styled(EuiFlexItem)` - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; `; const BuildingBlockContainer = styled(AdditionalFiltersItem)` diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/description_step/helpers.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/description_step/helpers.tsx index 394b1712df401..610bfd475c2b0 100644 --- a/x-pack/plugins/security_solution/public/detections/components/rules/description_step/helpers.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/rules/description_step/helpers.tsx @@ -167,7 +167,7 @@ const ThreatEuiFlexGroup = styled(EuiFlexGroup)` `; const SubtechniqueFlexItem = styled(EuiFlexItem)` - margin-left: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-left: ${({ theme }) => theme.eui.euiSizeM}; `; const TechniqueLinkItem = styled(EuiButtonEmpty)` diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/preview_table_control_columns.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/preview_table_control_columns.tsx index a110ceb8edaf6..2efc3256e9ce9 100644 --- a/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/preview_table_control_columns.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview/preview_table_control_columns.tsx @@ -18,7 +18,7 @@ const EventsTdContent = styled.div.attrs(({ className }) => ({ font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; min-width: 0; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; text-align: ${({ textAlign }) => textAlign}; width: ${({ width }) => width != null @@ -26,7 +26,7 @@ const EventsTdContent = styled.div.attrs(({ className }) => ({ : '100%'}; /* Using width: 100% instead of flex: 1 and max-width: 100% for IE11 */ button.euiButtonIcon { - margin-left: ${({ theme }) => `-${theme.eui.paddingSizes.xs}`}; + margin-left: ${({ theme }) => `-${theme.eui.euiSizeXS}`}; } `; diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_about_rule_details/index.test.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/step_about_rule_details/index.test.tsx index 8164c5099db4a..04111924c6e4e 100644 --- a/x-pack/plugins/security_solution/public/detections/components/rules/step_about_rule_details/index.test.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_about_rule_details/index.test.tsx @@ -20,7 +20,7 @@ import { getMockTheme } from '../../../../common/lib/kibana/kibana_react.mock'; jest.mock('../../../../common/lib/kibana'); const mockTheme = getMockTheme({ - eui: { euiSizeL: '10px', euiBreakpoints: { s: '450px' }, paddingSizes: { m: '10px' } }, + eui: { euiSizeL: '10px', euiBreakpoints: { s: '450px' }, euiSizeM: '10px' }, }); describe('StepAboutRuleToggleDetails', () => { diff --git a/x-pack/plugins/security_solution/public/detections/components/rules/step_define_rule/index.tsx b/x-pack/plugins/security_solution/public/detections/components/rules/step_define_rule/index.tsx index 40d76b43b5c0f..746550fe204cd 100644 --- a/x-pack/plugins/security_solution/public/detections/components/rules/step_define_rule/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/rules/step_define_rule/index.tsx @@ -85,7 +85,7 @@ const StyledButtonGroup = styled(EuiButtonGroup)` display: flex; justify-content: right; .euiButtonGroupButton { - padding-right: ${(props) => props.theme.eui.paddingSizes.l}; + padding-right: ${(props) => props.theme.eui.euiSizeL}; } `; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/utility_bar.test.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/utility_bar.test.tsx index 13a56a04fa71c..dbe26402e677a 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/utility_bar.test.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/all/utility_bar.test.tsx @@ -14,7 +14,7 @@ import { AllRulesUtilityBar } from './utility_bar'; import { getMockTheme } from '../../../../../common/lib/kibana/kibana_react.mock'; const mockTheme = getMockTheme({ - eui: { euiBreakpoints: { l: '1200px' }, paddingSizes: { m: '10px' } }, + eui: { euiBreakpoints: { l: '1200px' }, euiSizeM: '10px' }, }); describe('AllRules', () => { diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx index a6ff44f6d6f2a..ccf536bcf6ae1 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx @@ -100,9 +100,13 @@ const CreateRulePageComponent: React.FC = () => { const [activeStep, setActiveStep] = useState(RuleStep.defineRule); const getNextStep = (step: RuleStep): RuleStep | undefined => ruleStepsOrder[ruleStepsOrder.indexOf(step) + 1]; + // @ts-expect-error EUI team to resolve: https://github.com/elastic/eui/issues/5985 const defineRuleRef = useRef(null); + // @ts-expect-error EUI team to resolve: https://github.com/elastic/eui/issues/5985 const aboutRuleRef = useRef(null); + // @ts-expect-error EUI team to resolve: https://github.com/elastic/eui/issues/5985 const scheduleRuleRef = useRef(null); + // @ts-expect-error EUI team to resolve: https://github.com/elastic/eui/issues/5985 const ruleActionsRef = useRef(null); const formHooks = useRef({ [RuleStep.defineRule]: formHookNoop, diff --git a/x-pack/plugins/security_solution/public/hosts/components/first_last_seen_host/index.test.tsx b/x-pack/plugins/security_solution/public/hosts/components/first_last_seen_host/index.test.tsx index 7c1704319f429..d598406be2594 100644 --- a/x-pack/plugins/security_solution/public/hosts/components/first_last_seen_host/index.test.tsx +++ b/x-pack/plugins/security_solution/public/hosts/components/first_last_seen_host/index.test.tsx @@ -66,7 +66,7 @@ describe('FirstLastSeen Component', () => { await waitFor(() => { expect(getByTestId('test-render-output').innerHTML).toBe( - `
${firstSeen}
` + `
${firstSeen}
` ); }); }); @@ -83,7 +83,7 @@ describe('FirstLastSeen Component', () => { ); await waitFor(() => { expect(getByTestId('test-render-output').innerHTML).toBe( - `
${lastSeen}
` + `
${lastSeen}
` ); }); }); @@ -107,7 +107,7 @@ describe('FirstLastSeen Component', () => { await waitFor(() => { expect(getByTestId('test-render-output').innerHTML).toBe( - `
${lastSeen}
` + `
${lastSeen}
` ); }); }); @@ -131,7 +131,7 @@ describe('FirstLastSeen Component', () => { await waitFor(() => { expect(getByTestId('test-render-output').innerHTML).toBe( - `
${firstSeen}
` + `
${firstSeen}
` ); }); }); diff --git a/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx index 7dd76071056e1..b1a341ed1db96 100644 --- a/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx +++ b/x-pack/plugins/security_solution/public/hosts/pages/navigation/host_risk_tab_body.tsx @@ -22,7 +22,7 @@ import { useDashboardButtonHref } from '../../../common/hooks/use_dashboard_butt import { RISKY_HOSTS_DASHBOARD_TITLE } from './constants'; const StyledEuiFlexGroup = styled(EuiFlexGroup)` - margin-top: ${({ theme }) => theme.eui.paddingSizes.l}; + margin-top: ${({ theme }) => theme.eui.euiSizeL}; `; const QUERY_ID = HostRiskScoreQueryId.HOST_DETAILS_RISK_SCORE; diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts b/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts new file mode 100644 index 0000000000000..c7120947a9182 --- /dev/null +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/constants.ts @@ -0,0 +1,64 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ColumnHeaderOptions } from '../../../common/types/timeline'; +import { defaultColumnHeaderType } from '../../timelines/components/timeline/body/column_headers/default_headers'; +import { DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../timelines/components/timeline/body/constants'; +import { + COLUMN_SESSION_START, + COLUMN_EXECUTABLE, + COLUMN_ENTRY_USER, + COLUMN_INTERACTIVE, + COLUMN_ENTRY_TYPE, + COLUMN_NODE, + COLUMN_CONTAINER, + COLUMN_POD, +} from './translations'; + +export const kubernetesSessionsHeaders: ColumnHeaderOptions[] = [ + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.start', + initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH, + display: COLUMN_SESSION_START, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.user.name', + display: COLUMN_ENTRY_USER, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.executable', + display: COLUMN_EXECUTABLE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'cloud.instance.name', + display: COLUMN_NODE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.entry_meta.type', + display: COLUMN_ENTRY_TYPE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'process.entry_leader.interactive', + display: COLUMN_INTERACTIVE, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'container.name', + display: COLUMN_CONTAINER, + }, + { + columnHeaderType: defaultColumnHeaderType, + id: 'orchestrator.resource.name', + display: COLUMN_POD, + }, +]; diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx b/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx index 59ba4fa340e21..0176355b6672f 100644 --- a/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/index.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { useMemo } from 'react'; +import React, { useCallback, useMemo } from 'react'; import { getEsQueryConfig } from '@kbn/data-plugin/common'; import { SecuritySolutionPageWrapper } from '../../common/components/page_wrapper'; import { useKibana } from '../../common/lib/kibana'; @@ -21,6 +21,9 @@ import { useGlobalTime } from '../../common/containers/use_global_time'; import { useDeepEqualSelector } from '../../common/hooks/use_selector'; import { convertToBuildEsQuery } from '../../common/lib/keury'; import { useInvalidFilterQuery } from '../../common/hooks/use_invalid_filter_query'; +import { SessionsView } from '../../common/components/sessions_viewer'; +import { TimelineId } from '../../../common/types/timeline'; +import { kubernetesSessionsHeaders } from './constants'; export const KubernetesContainer = React.memo(() => { const { kubernetesSecurity, uiSettings } = useKibana().services; @@ -60,6 +63,21 @@ export const KubernetesContainer = React.memo(() => { endDate: to, }); + const renderSessionsView = useCallback( + (sessionsFilterQuery: string | undefined) => ( + + ), + [from, to] + ); + return ( {kubernetesSecurity.getKubernetesPage({ @@ -74,6 +92,7 @@ export const KubernetesContainer = React.memo(() => { startDate: from, endDate: to, }, + renderSessionsView, })} diff --git a/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts b/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts new file mode 100644 index 0000000000000..1b2c308c0bfa6 --- /dev/null +++ b/x-pack/plugins/security_solution/public/kubernetes/pages/translations.ts @@ -0,0 +1,57 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const COLUMN_SESSION_START = i18n.translate( + 'xpack.securitySolution.kubernetes.columnSessionStart', + { + defaultMessage: 'Date connected', + } +); + +export const COLUMN_EXECUTABLE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnExecutable', + { + defaultMessage: 'Session leader', + } +); + +export const COLUMN_NODE = i18n.translate('xpack.securitySolution.kubernetes.columnNode', { + defaultMessage: 'Node', +}); + +export const COLUMN_ENTRY_USER = i18n.translate( + 'xpack.securitySolution.kubernetes.columnEntryUser', + { + defaultMessage: 'Session entry users', + } +); + +export const COLUMN_INTERACTIVE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnInteractive', + { + defaultMessage: 'Interactivity', + } +); + +export const COLUMN_ENTRY_TYPE = i18n.translate( + 'xpack.securitySolution.kubernetes.columnEntryType', + { + defaultMessage: 'Entry mechanism', + } +); + +export const COLUMN_CONTAINER = i18n.translate( + 'xpack.securitySolution.kubernetes.columnContainer', + { + defaultMessage: 'Container', + } +); +export const COLUMN_POD = i18n.translate('xpack.securitySolution.kubernetes.columnPod', { + defaultMessage: 'Pod', +}); diff --git a/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_icons.tsx b/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_icons.tsx index 1515c9e03f33b..1326c071bd791 100644 --- a/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_icons.tsx +++ b/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_icons.tsx @@ -29,8 +29,8 @@ const Description = styled(EuiFlexItem)` `; const StyledEuiTitle = styled(EuiTitle)` - margin-top: ${({ theme }) => theme.eui.paddingSizes.m}; - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.xs}; + margin-top: ${({ theme }) => theme.eui.euiSizeM}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeXS}; `; export const LandingLinksIcons: React.FC = ({ items }) => ( diff --git a/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_images.tsx b/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_images.tsx index 4cf8db26bbe7a..cf6fd8dc481a4 100644 --- a/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_images.tsx +++ b/x-pack/plugins/security_solution/public/landing_pages/components/landing_links_images.tsx @@ -19,7 +19,7 @@ const PrimaryEuiTitle = styled(EuiTitle)` `; const LandingLinksDescripton = styled(EuiText)` - padding-top: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding-top: ${({ theme }) => theme.eui.euiSizeXS}; max-width: 550px; `; @@ -34,7 +34,7 @@ const StyledFlexItem = styled(EuiFlexItem)` const SecuritySolutionLink = withSecuritySolutionLink(Link); const Content = styled(EuiFlexItem)` - padding-left: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-left: ${({ theme }) => theme.eui.euiSizeS}; `; export const LandingLinksImages: React.FC = ({ items }) => ( diff --git a/x-pack/plugins/security_solution/public/landing_pages/pages/manage.tsx b/x-pack/plugins/security_solution/public/landing_pages/pages/manage.tsx index 06bd0c6258b57..33526e0122fc3 100644 --- a/x-pack/plugins/security_solution/public/landing_pages/pages/manage.tsx +++ b/x-pack/plugins/security_solution/public/landing_pages/pages/manage.tsx @@ -26,8 +26,8 @@ export const ManageLandingPage = () => ( ); const StyledEuiHorizontalRule = styled(EuiHorizontalRule)` - margin-top: ${({ theme }) => theme.eui.paddingSizes.m}; - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.l}; + margin-top: ${({ theme }) => theme.eui.euiSizeM}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeL}; `; type ManagementCategories = Array<{ label: string; links: NavLinkItem[] }>; diff --git a/x-pack/plugins/security_solution/public/management/components/artifact_card_grid/components/grid_header.tsx b/x-pack/plugins/security_solution/public/management/components/artifact_card_grid/components/grid_header.tsx index b25c3c3d6c2c9..a87a76e725a9f 100644 --- a/x-pack/plugins/security_solution/public/management/components/artifact_card_grid/components/grid_header.tsx +++ b/x-pack/plugins/security_solution/public/management/components/artifact_card_grid/components/grid_header.tsx @@ -15,7 +15,7 @@ import { useTestIdGenerator } from '../../../hooks/use_test_id_generator'; const GridHeaderContainer = styled(CardSectionPanel)` padding-top: 0; - padding-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-bottom: ${({ theme }) => theme.eui.euiSizeS}; `; export type GridHeaderProps = Pick & { diff --git a/x-pack/plugins/security_solution/public/management/components/back_to_external_app_button/back_to_external_app_button.tsx b/x-pack/plugins/security_solution/public/management/components/back_to_external_app_button/back_to_external_app_button.tsx index 34bd3634890c3..1fd6f86851eda 100644 --- a/x-pack/plugins/security_solution/public/management/components/back_to_external_app_button/back_to_external_app_button.tsx +++ b/x-pack/plugins/security_solution/public/management/components/back_to_external_app_button/back_to_external_app_button.tsx @@ -15,7 +15,7 @@ import { ListPageRouteState } from '../../../../common/endpoint/types'; import { useNavigateToAppEventHandler } from '../../../common/hooks/endpoint/use_navigate_to_app_event_handler'; const EuiButtonEmptyStyled = styled(EuiButtonEmpty)` - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; .euiIcon { width: ${({ theme }) => theme.eui.euiIconSizes.small}; @@ -24,7 +24,7 @@ const EuiButtonEmptyStyled = styled(EuiButtonEmpty)` .text { font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; - margin-inline-start: ${({ theme }) => theme.eui.paddingSizes.xs}; + margin-inline-start: ${({ theme }) => theme.eui.euiSizeXS}; } `; diff --git a/x-pack/plugins/security_solution/public/management/components/console/components/command_input/command_input.tsx b/x-pack/plugins/security_solution/public/management/components/console/components/command_input/command_input.tsx index 2a54cfe9c155e..cb561d69468fc 100644 --- a/x-pack/plugins/security_solution/public/management/components/console/components/command_input/command_input.tsx +++ b/x-pack/plugins/security_solution/public/management/components/console/components/command_input/command_input.tsx @@ -17,7 +17,7 @@ import { useDataTestSubj } from '../../hooks/state_selectors/use_data_test_subj' const CommandInputContainer = styled.div` background-color: ${({ theme: { eui } }) => eui.euiColorGhost}; border-radius: ${({ theme: { eui } }) => eui.euiBorderRadius}; - padding: ${({ theme: { eui } }) => eui.paddingSizes.s}; + padding: ${({ theme: { eui } }) => eui.euiSizeS}; .prompt { padding-right: 1ch; @@ -31,7 +31,7 @@ const CommandInputContainer = styled.div` display: inline-block; width: 0.5em; height: 1em; - background-color: ${({ theme }) => theme.eui.euiTextColors.default}; + background-color: ${({ theme }) => theme.eui.euiTextColor}; animation: cursor-blink-animation 1s steps(5, start) infinite; -webkit-animation: cursor-blink-animation 1s steps(5, start) infinite; diff --git a/x-pack/plugins/security_solution/public/management/components/console/components/history_item.tsx b/x-pack/plugins/security_solution/public/management/components/console/components/history_item.tsx index 2cc5ae405d56d..001ac7793a594 100644 --- a/x-pack/plugins/security_solution/public/management/components/console/components/history_item.tsx +++ b/x-pack/plugins/security_solution/public/management/components/console/components/history_item.tsx @@ -14,7 +14,7 @@ import { useDataTestSubj } from '../hooks/state_selectors/use_data_test_subj'; const StyledEuiFlexItemHistoryItem = styled(EuiFlexItem)` border-bottom: ${({ theme: { eui } }) => eui.euiBorderWidthThin} dashed ${({ theme: { eui } }) => eui.euiBorderColor}; - padding: ${({ theme: { eui } }) => eui.paddingSizes.xl} 0; + padding: ${({ theme: { eui } }) => eui.euiSizeXL} 0; `; export type HistoryItemProps = PropsWithChildren<{}>; diff --git a/x-pack/plugins/security_solution/public/management/components/console/console.tsx b/x-pack/plugins/security_solution/public/management/components/console/console.tsx index 3306870fea948..c7db0ce797ec9 100644 --- a/x-pack/plugins/security_solution/public/management/components/console/console.tsx +++ b/x-pack/plugins/security_solution/public/management/components/console/console.tsx @@ -30,14 +30,13 @@ const ConsoleWindow = styled.div` } &-bottomBorder { - border-bottom: ${({ theme: { eui } }) => eui.paddingSizes.s} solid + border-bottom: ${({ theme: { eui } }) => eui.euiSizeS} solid ${({ theme: { eui } }) => eui.euiPageBackgroundColor}; } &-container { - padding: ${({ theme: { eui } }) => eui.paddingSizes.l} - ${({ theme: { eui } }) => eui.paddingSizes.l} ${({ theme: { eui } }) => eui.paddingSizes.s} - ${({ theme: { eui } }) => eui.paddingSizes.l}; + padding: ${({ theme: { eui } }) => eui.euiSizeL} ${({ theme: { eui } }) => eui.euiSizeL} + ${({ theme: { eui } }) => eui.euiSizeS} ${({ theme: { eui } }) => eui.euiSizeL}; } &-header { @@ -47,7 +46,7 @@ const ConsoleWindow = styled.div` &-rightPanel { width: 35%; background-color: ${({ theme: { eui } }) => eui.euiColorGhost}; - border-bottom: ${({ theme: { eui } }) => eui.paddingSizes.s} solid + border-bottom: ${({ theme: { eui } }) => eui.euiSizeS} solid ${({ theme: { eui } }) => eui.euiPageBackgroundColor}; } @@ -61,7 +60,7 @@ const ConsoleWindow = styled.div` } &-commandInput { - padding-top: ${({ theme: { eui } }) => eui.paddingSizes.xs}; + padding-top: ${({ theme: { eui } }) => eui.euiSizeXS}; } } diff --git a/x-pack/plugins/security_solution/public/management/components/effected_policy_select/effected_policy_select.tsx b/x-pack/plugins/security_solution/public/management/components/effected_policy_select/effected_policy_select.tsx index e33c7ba467ff5..72ed2449b87e1 100644 --- a/x-pack/plugins/security_solution/public/management/components/effected_policy_select/effected_policy_select.tsx +++ b/x-pack/plugins/security_solution/public/management/components/effected_policy_select/effected_policy_select.tsx @@ -56,7 +56,7 @@ const StyledButtonGroup = styled(EuiButtonGroup)` display: flex; justify-content: right; .euiButtonGroupButton { - padding-right: ${(props) => props.theme.eui.paddingSizes.l}; + padding-right: ${(props) => props.theme.eui.euiSizeL}; } `; diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_agent_and_isolation_status/endpoint_agent_and_isolation_status.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_agent_and_isolation_status/endpoint_agent_and_isolation_status.tsx index f75b673943b2b..2170456ee57de 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_agent_and_isolation_status/endpoint_agent_and_isolation_status.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_agent_and_isolation_status/endpoint_agent_and_isolation_status.tsx @@ -18,7 +18,7 @@ import { const EuiFlexGroupStyled = styled(EuiFlexGroup)` .isolation-status { - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; } `; diff --git a/x-pack/plugins/security_solution/public/management/components/page_overlay/page_overlay.tsx b/x-pack/plugins/security_solution/public/management/components/page_overlay/page_overlay.tsx index 44fe1a6ce410b..b765bd2630125 100644 --- a/x-pack/plugins/security_solution/public/management/components/page_overlay/page_overlay.tsx +++ b/x-pack/plugins/security_solution/public/management/components/page_overlay/page_overlay.tsx @@ -55,19 +55,19 @@ const OverlayRootContainer = styled.div` } &.padding-xs { - padding: ${({ theme: { eui } }) => eui.paddingSizes.xs}; + padding: ${({ theme: { eui } }) => eui.euiSizeXS}; } &.padding-s { - padding: ${({ theme: { eui } }) => eui.paddingSizes.s}; + padding: ${({ theme: { eui } }) => eui.euiSizeS}; } &.padding-m { - padding: ${({ theme: { eui } }) => eui.paddingSizes.m}; + padding: ${({ theme: { eui } }) => eui.euiSizeM}; } &.padding-l { - padding: ${({ theme: { eui } }) => eui.paddingSizes.l}; + padding: ${({ theme: { eui } }) => eui.euiSizeL}; } &.padding-xl { - padding: ${({ theme: { eui } }) => eui.paddingSizes.xl}; + padding: ${({ theme: { eui } }) => eui.euiSizeXL}; } .fullHeight { diff --git a/x-pack/plugins/security_solution/public/management/components/paginated_content/paginated_content.tsx b/x-pack/plugins/security_solution/public/management/components/paginated_content/paginated_content.tsx index 6afdd339e52b9..b194a29c4292f 100644 --- a/x-pack/plugins/security_solution/public/management/components/paginated_content/paginated_content.tsx +++ b/x-pack/plugins/security_solution/public/management/components/paginated_content/paginated_content.tsx @@ -82,7 +82,7 @@ interface TypedGenericComponentMemo { const RootContainer = styled.div` position: relative; - padding-top: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding-top: ${({ theme }) => theme.eui.euiSizeXS}; .body { min-height: ${({ theme }) => theme.eui.gutterTypes.gutterExtraLarge}; diff --git a/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response.tsx b/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response.tsx index 027e8e541d89b..03b6fd36b318f 100644 --- a/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response.tsx +++ b/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response.tsx @@ -39,8 +39,8 @@ const StyledEuiTreeView = styled(EuiTreeView)` .euiTreeView__node { // When response action item displays a callout, this needs to be overwritten to remove the default max height of EuiTreeView max-height: none !important; - padding-top: ${({ theme }) => theme.eui.paddingSizes.s}; - padding-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + padding-top: ${({ theme }) => theme.eui.euiSizeS}; + padding-bottom: ${({ theme }) => theme.eui.euiSizeS}; } } } diff --git a/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response_action_item.tsx b/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response_action_item.tsx index 65529f96fff2c..9be8a080df731 100644 --- a/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response_action_item.tsx +++ b/x-pack/plugins/security_solution/public/management/components/policy_response/policy_response_action_item.tsx @@ -11,7 +11,7 @@ import { EuiLink, EuiCallOut, EuiText } from '@elastic/eui'; import { PolicyResponseActionFormatter } from './policy_response_friendly_names'; const StyledEuiCallout = styled(EuiCallOut)` - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; .action-message { white-space: break-spaces; text-align: left; diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/components/endpoint_agent_status.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/components/endpoint_agent_status.tsx index d422fb736965a..095382ace780e 100644 --- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/components/endpoint_agent_status.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/components/endpoint_agent_status.tsx @@ -16,7 +16,7 @@ import { AgentStatus } from '../../../../../common/components/endpoint/agent_sta const EuiFlexGroupStyled = styled(EuiFlexGroup)` .isolation-status { - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; } `; diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/activity_log_date_range_picker/index.tsx b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/activity_log_date_range_picker/index.tsx index 423f6188c1b8c..47304fe5b28d8 100644 --- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/activity_log_date_range_picker/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/view/details/components/activity_log_date_range_picker/index.tsx @@ -38,7 +38,7 @@ const StickyFlexItem = styled(EuiFlexItem)` position: sticky; top: 0; z-index: 1; - padding: ${(props) => `${props.theme.eui.paddingSizes.m}`}; + padding: ${(props) => `${props.theme.eui.euiSizeM}`}; `; export const DateRangePicker = memo(() => { diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/models/advanced_policy_schema.ts b/x-pack/plugins/security_solution/public/management/pages/policy/models/advanced_policy_schema.ts index 28d0a3a91029d..dc230057d637c 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/models/advanced_policy_schema.ts +++ b/x-pack/plugins/security_solution/public/management/pages/policy/models/advanced_policy_schema.ts @@ -12,6 +12,7 @@ interface AdvancedPolicySchemaType { first_supported_version: string; last_supported_version?: string; documentation: string; + license?: string; } export const AdvancedPolicySchema: AdvancedPolicySchemaType[] = [ @@ -936,4 +937,15 @@ export const AdvancedPolicySchema: AdvancedPolicySchemaType[] = [ } ), }, + { + key: 'windows.advanced.rollback', + first_supported_version: '8.4', + documentation: i18n.translate( + 'xpack.securitySolution.endpoint.policy.advanced.windows.rollback', + { + defaultMessage: 'Experimental', + } + ), + license: 'platinum', + }, ]; diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/components/events_form/index.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/components/events_form/index.tsx index 77debc1c866b6..e64f480fd175d 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/components/events_form/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/components/events_form/index.tsx @@ -119,7 +119,7 @@ const InnerEventsForm = ({ {supplementalOptions && supplementalOptions.map(({ name, protectionField, tooltipText, beta }) => { return ( -
+
diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/exception_items_summary.test.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/exception_items_summary.test.tsx index c98def71f8a59..4a4364f8d7d03 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/exception_items_summary.test.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/exception_items_summary.test.tsx @@ -15,7 +15,7 @@ import { GetExceptionSummaryResponse } from '../../../../../../../../common/endp const mockTheme = getMockTheme({ eui: { - paddingSizes: { m: '2' }, + euiSizeM: '2', }, }); diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/link_with_icon.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/link_with_icon.tsx index 6aebb130eb896..0da81029c2517 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/link_with_icon.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_package_custom_extension/components/link_with_icon.tsx @@ -17,7 +17,7 @@ const LinkLabel = styled.span<{ size?: 'm' | 'l'; }>` display: inline-block; - padding-right: ${(props) => props.theme.eui.paddingSizes.s}; + padding-right: ${(props) => props.theme.eui.euiSizeS}; font-size: ${({ size, theme }) => (size === 'm' ? theme.eui.euiFontSizeXS : 'innherit')}; `; diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_advanced.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_advanced.tsx index 7da01f80fd047..e6eab89e4f18f 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_advanced.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_advanced.tsx @@ -95,7 +95,7 @@ const warningMessage = i18n.translate( } ); -export const AdvancedPolicyForms = React.memo(() => { +export const AdvancedPolicyForms = React.memo(({ isPlatinumPlus }: { isPlatinumPlus: boolean }) => { return ( <> @@ -113,14 +113,17 @@ export const AdvancedPolicyForms = React.memo(() => { {AdvancedPolicySchema.map((advancedField, index) => { const configPath = advancedField.key.split('.'); + const failsPlatinumLicenseCheck = !isPlatinumPlus && advancedField.license === 'platinum'; return ( - + !failsPlatinumLicenseCheck && ( + + ) ); })} diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details_form.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details_form.tsx index 747bde112d89a..794e7533371d4 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details_form.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_details_form.tsx @@ -104,7 +104,7 @@ export const PolicyDetailsForm = memo(() => { - {showAdvancedPolicy && } + {showAdvancedPolicy && } ); }); diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/vertical_divider.ts b/x-pack/plugins/security_solution/public/management/pages/policy/view/vertical_divider.ts index 166f4472bb7b2..b1b26737e9eab 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/vertical_divider.ts +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/vertical_divider.ts @@ -6,9 +6,8 @@ */ import styled from 'styled-components'; -import { EuiTheme } from '@kbn/kibana-react-plugin/common'; -type SpacingOptions = keyof EuiTheme['eui']['paddingSizes']; +type SpacingOptions = 'xs' | 's' | 'm' | 'l' | 'xl'; /** * A vertical divider - show a vertical line that spans 100% of the height of its parent container. @@ -20,9 +19,13 @@ type SpacingOptions = keyof EuiTheme['eui']['paddingSizes']; export const VerticalDivider = styled.div<{ spacing?: SpacingOptions }>` width: 0; height: 100%; - border-left: ${(props) => { - return props.theme.eui.euiBorderThin; + border-left: ${(props) => props.theme.eui.euiBorderThin}; + margin-left: ${(props) => { + const size = props?.spacing && `euiSize${props.spacing.toUpperCase()}`; + return size ? props.theme.eui[size] : 0; + }}; + margin-right: ${(props) => { + const size = props?.spacing && `euiSize${props.spacing.toUpperCase()}`; + return size ? props.theme.eui[size] : 0; }}; - margin-left: ${(props) => props.theme.eui.paddingSizes[props?.spacing ?? 'none'] || 0}; - margin-right: ${(props) => props.theme.eui.paddingSizes[props?.spacing ?? 'none'] || 0}; `; diff --git a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/condition_group/index.tsx b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/condition_group/index.tsx index a9785e7dab9b6..7cf9d74592a29 100644 --- a/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/condition_group/index.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/trusted_apps/view/components/condition_group/index.tsx @@ -22,15 +22,15 @@ const ConditionGroupFlexGroup = styled(EuiFlexGroup)` .and-badge { padding-top: 20px; padding-bottom: ${({ theme }) => { - return `calc(${theme.eui.euiButtonHeightSmall} + (${theme.eui.paddingSizes.s} * 2) + 3px);`; + return `calc(${theme.eui.euiButtonHeightSmall} + (${theme.eui.euiSizeS} * 2) + 3px);`; }}; } .group-entries { - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; & > * { - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeS}; &:last-child { margin-bottom: 0; diff --git a/x-pack/plugins/security_solution/public/network/components/embeddables/embedded_map.test.tsx b/x-pack/plugins/security_solution/public/network/components/embeddables/embedded_map.test.tsx index 2166d6b495e75..1bd46f848f3ae 100644 --- a/x-pack/plugins/security_solution/public/network/components/embeddables/embedded_map.test.tsx +++ b/x-pack/plugins/security_solution/public/network/components/embeddables/embedded_map.test.tsx @@ -199,7 +199,7 @@ describe('EmbeddedMapComponent', () => { expect(wrapper.find('[data-test-subj="siemEmbeddable"]').first().exists()).toEqual(false); - const container = wrapper.find('[data-test-subj="false-toggle-network-map"]').at(0); + const container = wrapper.find('[data-test-subj="false-toggle-network-map"]').last(); container.simulate('click'); await waitFor(() => { @@ -217,7 +217,7 @@ describe('EmbeddedMapComponent', () => { ); expect(wrapper.find('[data-test-subj="siemEmbeddable"]').first().exists()).toEqual(true); - const container = wrapper.find('[data-test-subj="true-toggle-network-map"]').at(0); + const container = wrapper.find('[data-test-subj="true-toggle-network-map"]').last(); container.simulate('click'); await waitFor(() => { diff --git a/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx b/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx index b0b1e99e4257b..a5d90fdb5fad8 100644 --- a/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx @@ -39,7 +39,7 @@ const DEFAULT_STACK_BY = 'event.module'; const StyledLinkButton = styled(EuiButton)` margin-left: 0; @media only screen and (min-width: ${(props) => props.theme.eui.euiBreakpoints.m}) { - margin-left: ${({ theme }) => theme.eui.paddingSizes.l}; + margin-left: ${({ theme }) => theme.eui.euiSizeL}; } `; interface Props extends Pick { diff --git a/x-pack/plugins/security_solution/public/overview/components/detection_response/alerts_by_status/chart_label.tsx b/x-pack/plugins/security_solution/public/overview/components/detection_response/alerts_by_status/chart_label.tsx index ad609102409d2..684c1db54670c 100644 --- a/x-pack/plugins/security_solution/public/overview/components/detection_response/alerts_by_status/chart_label.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/detection_response/alerts_by_status/chart_label.tsx @@ -13,7 +13,7 @@ interface ChartLabelProps { } const PlaceHolder = styled.div` - padding: ${(props) => props.theme.eui.paddingSizes.s}; + padding: ${(props) => props.theme.eui.euiSizeS}; `; const ChartLabelComponent: React.FC = ({ count }) => { diff --git a/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx b/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx index 1e929e222a02a..b9f00ea2e65a2 100644 --- a/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx @@ -68,7 +68,7 @@ const getHistogramOption = (fieldName: string): MatrixHistogramOption => ({ const StyledLinkButton = styled(EuiButton)` margin-left: 0; @media only screen and (min-width: ${(props) => props.theme.eui.euiBreakpoints.m}) { - margin-left: ${({ theme }) => theme.eui.paddingSizes.l}; + margin-left: ${({ theme }) => theme.eui.euiSizeL}; } `; diff --git a/x-pack/plugins/security_solution/public/overview/components/link_panel/inner_link_panel.tsx b/x-pack/plugins/security_solution/public/overview/components/link_panel/inner_link_panel.tsx index 07ecce00a1c57..bfa8860188d8e 100644 --- a/x-pack/plugins/security_solution/public/overview/components/link_panel/inner_link_panel.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/link_panel/inner_link_panel.tsx @@ -10,24 +10,24 @@ import styled from 'styled-components'; import { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiSplitPanel, EuiText } from '@elastic/eui'; const ButtonContainer = styled(EuiFlexGroup)` - padding: ${({ theme }) => theme.eui.paddingSizes.s}; + padding: ${({ theme }) => theme.eui.euiSizeS}; `; const Icon = styled(EuiIcon)` padding: 0; - margin-top: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-top: ${({ theme }) => theme.eui.euiSizeM}; margin-left: 12px; transform: scale(${({ color }) => (color === 'primary' ? 1.4 : 1)}); `; const PanelContainer = styled(EuiSplitPanel.Inner)` - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeM}; `; const Title = styled(EuiText)<{ textcolor: 'primary' | 'warning' }>` color: ${({ theme, textcolor }) => textcolor === 'primary' ? theme.eui.euiColorPrimary : theme.eui.euiColorWarningText}; - margin-bottom: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-bottom: ${({ theme }) => theme.eui.euiSizeM}; `; export const InnerLinkPanel = ({ diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_cti_links/mock.ts b/x-pack/plugins/security_solution/public/overview/components/overview_cti_links/mock.ts index c4cf876cbdc7d..f631084d880bf 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_cti_links/mock.ts +++ b/x-pack/plugins/security_solution/public/overview/components/overview_cti_links/mock.ts @@ -11,7 +11,8 @@ export const mockTheme = getMockTheme({ eui: { euiSizeL: '10px', euiBreakpoints: { s: '10px' }, - paddingSizes: { s: '10px', m: '10px', l: '10px' }, + euiSizeS: '10px', + euiSizeM: '10px', }, }); diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_host_stats/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/overview/components/overview_host_stats/__snapshots__/index.test.tsx.snap index 3fb85fd45a48d..fb34d6e2f66a4 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_host_stats/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/overview/components/overview_host_stats/__snapshots__/index.test.tsx.snap @@ -7,8 +7,7 @@ exports[`Overview Host Stat Data rendering it renders the default OverviewHostSt - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="host-stat-accordion-groupauditbeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="host-stat-accordion-groupendgame" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="host-stat-accordion-groupfilebeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="host-stat-accordion-groupwinlogbeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + `; diff --git a/x-pack/plugins/security_solution/public/overview/components/overview_network_stats/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/overview/components/overview_network_stats/__snapshots__/index.test.tsx.snap index 032b0592bbcb8..16755da7d787e 100644 --- a/x-pack/plugins/security_solution/public/overview/components/overview_network_stats/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/overview/components/overview_network_stats/__snapshots__/index.test.tsx.snap @@ -7,8 +7,7 @@ exports[`Overview Network Stat Data rendering it renders the default OverviewNet - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="network-stat-accordion-groupauditbeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="network-stat-accordion-groupfilebeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + - } buttonContentClassName="accordion-button" - buttonElement="button" - element="div" id="network-stat-accordion-grouppacketbeat" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + `; diff --git a/x-pack/plugins/security_solution/public/resolver/test_utilities/react_wrapper.ts b/x-pack/plugins/security_solution/public/resolver/test_utilities/react_wrapper.ts deleted file mode 100644 index 79205a0420505..0000000000000 --- a/x-pack/plugins/security_solution/public/resolver/test_utilities/react_wrapper.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { ReactWrapper } from 'enzyme'; - -/** - * Return a collection of attribute 'entries'. - * The 'entries' are attributeName-attributeValue tuples. - */ -export function attributeEntries(wrapper: ReactWrapper): Array<[string, string]> { - return Array.prototype.slice - .call(wrapper.getDOMNode().attributes) - .map(({ name, value }) => [name, value]); -} diff --git a/x-pack/plugins/security_solution/public/resolver/view/panels/descriptive_name.test.tsx b/x-pack/plugins/security_solution/public/resolver/view/panels/descriptive_name.test.tsx index 75698bf726642..cef8aa718985f 100644 --- a/x-pack/plugins/security_solution/public/resolver/view/panels/descriptive_name.test.tsx +++ b/x-pack/plugins/security_solution/public/resolver/view/panels/descriptive_name.test.tsx @@ -6,46 +6,48 @@ */ import React from 'react'; +import { render, screen } from '@testing-library/react'; +import { I18nProvider } from '@kbn/i18n-react'; + import { EndpointDocGenerator } from '../../../../common/endpoint/generate_data'; import { DescriptiveName } from './descriptive_name'; import { SafeResolverEvent } from '../../../../common/endpoint/types'; -import { mount, ReactWrapper } from 'enzyme'; -import { I18nProvider } from '@kbn/i18n-react'; describe('DescriptiveName', () => { - let generator: EndpointDocGenerator; - let wrapper: (event: SafeResolverEvent) => ReactWrapper; - beforeEach(() => { - generator = new EndpointDocGenerator('seed'); - wrapper = (event: SafeResolverEvent) => - mount( - - - - ); - }); + const generator = new EndpointDocGenerator('seed'); + + function renderEvent(event: SafeResolverEvent) { + render( + + + + ); + } + it('returns the right name for a registry event', () => { const extensions = { registry: { key: `HKLM/Windows/Software/abc` } }; - const event = generator.generateEvent({ eventCategory: 'registry', extensions }); - expect(wrapper(event).text()).toEqual(`HKLM/Windows/Software/abc`); + renderEvent(generator.generateEvent({ eventCategory: 'registry', extensions })); + expect(screen.queryByText('HKLM/Windows/Software/abc')).toBeInTheDocument(); }); it('returns the right name for a network event', () => { const randomIP = `${generator.randomIP()}`; const extensions = { network: { direction: 'outbound', forwarded_ip: randomIP } }; - const event = generator.generateEvent({ eventCategory: 'network', extensions }); - expect(wrapper(event).text()).toEqual(`outbound ${randomIP}`); + renderEvent(generator.generateEvent({ eventCategory: 'network', extensions })); + expect(screen.queryByText(`outbound ${randomIP}`)).toBeInTheDocument(); }); it('returns the right name for a file event', () => { const extensions = { file: { path: 'C:\\My Documents\\business\\January\\processName' } }; - const event = generator.generateEvent({ eventCategory: 'file', extensions }); - expect(wrapper(event).text()).toEqual('C:\\My Documents\\business\\January\\processName'); + renderEvent(generator.generateEvent({ eventCategory: 'file', extensions })); + expect( + screen.queryByText('C:\\My Documents\\business\\January\\processName') + ).toBeInTheDocument(); }); it('returns the right name for a dns event', () => { const extensions = { dns: { question: { name: `${generator.randomIP()}` } } }; - const event = generator.generateEvent({ eventCategory: 'dns', extensions }); - expect(wrapper(event).text()).toEqual(extensions.dns.question.name); + renderEvent(generator.generateEvent({ eventCategory: 'dns', extensions })); + expect(screen.queryByText(extensions.dns.question.name)).toBeInTheDocument(); }); }); diff --git a/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx b/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx index 707afeea81cc8..21a3f6d9ce066 100644 --- a/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx +++ b/x-pack/plugins/security_solution/public/resolver/view/panels/event_detail.tsx @@ -17,6 +17,7 @@ import { EuiSpacer, EuiText, EuiDescriptionList, + EuiHorizontalRule, EuiTextColor, EuiTitle, } from '@elastic/eui'; @@ -330,20 +331,12 @@ const StyledDescriptiveName = memo(styled(EuiText)` `); const StyledFlexTitle = memo(styled('h3')` + align-items: center; display: flex; flex-flow: row; font-size: 1.2em; `); -const StyledTitleRule = memo(styled('hr')` - &.euiHorizontalRule.euiHorizontalRule--full.euiHorizontalRule--marginSmall.override { - display: block; - flex: 1; - margin-left: 0.5em; - } -`); const TitleHr = memo(() => { - return ( - - ); + return ; }); diff --git a/x-pack/plugins/security_solution/public/resolver/view/panels/use_formatted_date.test.tsx b/x-pack/plugins/security_solution/public/resolver/view/panels/use_formatted_date.test.tsx index 1c3f1948edc4d..b388e31444a25 100644 --- a/x-pack/plugins/security_solution/public/resolver/view/panels/use_formatted_date.test.tsx +++ b/x-pack/plugins/security_solution/public/resolver/view/panels/use_formatted_date.test.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import { mount } from 'enzyme'; +import { render, screen } from '@testing-library/react'; import React from 'react'; import { useFormattedDate } from './use_formatted_date'; @@ -16,23 +16,11 @@ import { uiSetting } from '../../mocks/ui_setting'; describe(`useFormattedDate, when the "dateFormat" UI setting is "${uiSetting( 'dateFormat' )}" and the "dateFormat:tz" setting is "${uiSetting('dateFormat:tz')}"`, () => { - let formattedDate: (date: ConstructorParameters[0] | Date | undefined) => string; - - beforeEach(async () => { - const mockCoreStart = coreMock.createStart(); - mockCoreStart.uiSettings.get.mockImplementation(uiSetting); - - function Test({ date }: { date: ConstructorParameters[0] | Date | undefined }) { - return <>{useFormattedDate(date)}; - } - - formattedDate = (date: ConstructorParameters[0] | Date | undefined): string => - mount( - - - - ).text(); - }); + function Test({ date }: { date: ConstructorParameters[0] | Date | undefined }) { + return {useFormattedDate(date)}; + } + const mockCoreStart = coreMock.createStart(); + mockCoreStart.uiSettings.get.mockImplementation(uiSetting); it.each([ ['randomString', 'an invalid string', 'Invalid Date'], @@ -51,6 +39,11 @@ describe(`useFormattedDate, when the "dateFormat" UI setting is "${uiSetting( ], [new Date(1600863932316), 'a defined Date object', 'Sep 23, 2020 @ 08:25:32.316'], ])('when the provided date is %p (%s) it should return %p', (value, _explanation, expected) => { - expect(formattedDate(value)).toBe(expected); + render( + + + + ); + expect(screen.queryByTestId('useFormattedDateTest')?.textContent).toBe(expected); }); }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx index 05bc3992791f6..0d839bed721bd 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/fields_browser/create_field_button/index.tsx @@ -14,7 +14,7 @@ import type { OpenFieldEditor } from '..'; import * as i18n from './translations'; const StyledButton = styled(EuiButton)` - margin-left: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-left: ${({ theme }) => theme.eui.euiSizeM}; `; export interface UseCreateFieldButtonProps { diff --git a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline.test.tsx index 07e494769a211..d754aeba9072b 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline.test.tsx @@ -35,9 +35,7 @@ jest.mock('react-router-dom', () => { const mockTheme = getMockTheme({ eui: { euiSizeL: '10px', - paddingSizes: { - s: '10px', - }, + euiSizeS: '10px', euiBreakpoints: { l: '1200px', }, diff --git a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline_modal/open_timeline_modal_body.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline_modal/open_timeline_modal_body.test.tsx index ddf35eec86e04..7e00290c380db 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline_modal/open_timeline_modal_body.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/open_timeline_modal/open_timeline_modal_body.test.tsx @@ -29,7 +29,7 @@ describe('OpenTimelineModal', () => { euiBreakpoints: { s: '500px', }, - paddingSizes: { m: '16px' }, + euiSizeM: '16px', }, }); const title = 'All Timelines / Open Timelines'; diff --git a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/title_row/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/title_row/index.test.tsx index 9e54d708db496..ed68bba3b59e3 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/open_timeline/title_row/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/open_timeline/title_row/index.test.tsx @@ -19,7 +19,7 @@ const mockTheme = getMockTheme({ euiLineHeight: 10, euiBreakpoints: { s: '10px' }, euiSize: '10px', - paddingSizes: { m: '16px' }, + euiSizeM: '16px', }, }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/timelines/components/side_panel/__snapshots__/index.test.tsx.snap index 0874df6264a8f..b7323aa7559ca 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/__snapshots__/index.test.tsx.snap @@ -144,7 +144,7 @@ exports[`Details Panel Component DetailsPanel:EventDetails: rendering it should -ms-flex: 1; flex: 1; overflow: hidden; - padding: 0 16px 16px; + padding: 0 12px 12px; }
`0 ${theme.eui.paddingSizes.m} ${theme.eui.paddingSizes.m}`}; + padding: ${({ theme }) => `0 ${theme.eui.euiSizeM} ${theme.eui.euiSizeM}`}; } } `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/__snapshots__/expandable_host.test.tsx.snap b/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/__snapshots__/expandable_host.test.tsx.snap index 1f4108c18134b..3cdad643a7656 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/__snapshots__/expandable_host.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/__snapshots__/expandable_host.test.tsx.snap @@ -65,7 +65,7 @@ exports[`Expandable Host Component ExpandableHostDetails: rendering it should re } .c4 { - padding: 16px; + padding: 12px; background: rgba(250,251,253,0.9); bottom: 0; left: 0; diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/index.tsx index 0a06810bb1249..0af88fe094b0a 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/host_details/index.tsx @@ -35,7 +35,7 @@ const StyledEuiFlyoutBody = styled(EuiFlyoutBody)` overflow-x: hidden; overflow-y: scroll; margin-bottom: 64px; // account for firefox, which doesn't seem to respect the bottom padding - padding: ${({ theme }) => `${theme.eui.paddingSizes.xs} ${theme.eui.paddingSizes.m} 0px`}; + padding: ${({ theme }) => `${theme.eui.euiSizeXS} ${theme.eui.euiSizeM} 0px`}; } } `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/index.tsx index ec731416cab1b..96b9c62d6817f 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/index.tsx @@ -36,7 +36,7 @@ const StyledEuiFlyoutBody = styled(EuiFlyoutBody)` flex: 1; overflow-x: hidden; overflow-y: scroll; - padding: ${({ theme }) => `${theme.eui.paddingSizes.xs} ${theme.eui.paddingSizes.m} 64px`}; + padding: ${({ theme }) => `${theme.eui.euiSizeXS} ${theme.eui.euiSizeM} 64px`}; } } `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/user_details/user_details_flyout.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/user_details/user_details_flyout.tsx index 6fb8a9e892400..9ffbeabf6609f 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/user_details/user_details_flyout.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/user_details/user_details_flyout.tsx @@ -26,7 +26,7 @@ const StyledEuiFlyoutBody = styled(EuiFlyoutBody)` flex: 1; overflow-x: hidden; overflow-y: scroll; - padding: ${({ theme }) => `${theme.eui.paddingSizes.xs} ${theme.eui.paddingSizes.m} 64px`}; + padding: ${({ theme }) => `${theme.eui.euiSizeXS} ${theme.eui.euiSizeM} 64px`}; } } `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.test.tsx new file mode 100644 index 0000000000000..1f4d0e9e8d12c --- /dev/null +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.test.tsx @@ -0,0 +1,68 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { render, screen } from '@testing-library/react'; +import React from 'react'; + +import { AddEventNoteAction } from './add_note_icon_item'; +import { useUserPrivileges } from '../../../../../common/components/user_privileges'; +import { getEndpointPrivilegesInitialStateMock } from '../../../../../common/components/user_privileges/endpoint/mocks'; +import { TestProviders } from '../../../../../common/mock'; +import { TimelineType } from '../../../../../../common/types'; + +jest.mock('../../../../../common/components/user_privileges'); +const useUserPrivilegesMock = useUserPrivileges as jest.Mock; + +describe('AddEventNoteAction', () => { + beforeEach(() => { + jest.resetAllMocks(); + }); + + describe('isDisabled', () => { + test('it disables the add note button when the user does NOT have crud privileges', () => { + useUserPrivilegesMock.mockReturnValue({ + kibanaSecuritySolutionsPrivileges: { crud: false, read: true }, + endpointPrivileges: getEndpointPrivilegesInitialStateMock(), + }); + + render( + + + + ); + + expect(screen.getByTestId('timeline-notes-button-small')).toHaveClass( + 'euiButtonIcon-isDisabled' + ); + }); + + test('it enables the add note button when the user has crud privileges', () => { + useUserPrivilegesMock.mockReturnValue({ + kibanaSecuritySolutionsPrivileges: { crud: true, read: true }, + endpointPrivileges: getEndpointPrivilegesInitialStateMock(), + }); + + render( + + + + ); + + expect(screen.getByTestId('timeline-notes-button-small')).not.toHaveClass( + 'euiButtonIcon-isDisabled' + ); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.tsx index 22c40ba78b0fe..784685997e5ff 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/add_note_icon_item.tsx @@ -11,6 +11,7 @@ import { TimelineType } from '../../../../../../common/types/timeline'; import * as i18n from '../translations'; import { NotesButton } from '../../properties/helpers'; import { ActionIconItem } from './action_icon_item'; +import { useUserPrivileges } from '../../../../../common/components/user_privileges'; interface AddEventNoteActionProps { ariaLabel?: string; @@ -24,20 +25,25 @@ const AddEventNoteActionComponent: React.FC = ({ showNotes, timelineType, toggleShowNotes, -}) => ( - - - -); +}) => { + const { kibanaSecuritySolutionsPrivileges } = useUserPrivileges(); + + return ( + + + + ); +}; AddEventNoteActionComponent.displayName = 'AddEventNoteActionComponent'; diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx index 6d05e5304150e..87f16dbb7e519 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/header_actions.tsx @@ -56,7 +56,7 @@ const SortingColumnsContainer = styled.div` const FieldBrowserContainer = styled.div` .euiToolTipAnchor { .euiButtonContent { - padding: ${({ theme }) => `0 ${theme.eui.paddingSizes.xs}`}; + padding: ${({ theme }) => `0 ${theme.eui.euiSizeXS}`}; } button { color: ${({ theme }) => theme.eui.euiColorPrimary}; diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.test.tsx new file mode 100644 index 0000000000000..e94c2ac2a38f0 --- /dev/null +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.test.tsx @@ -0,0 +1,68 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { render, screen } from '@testing-library/react'; +import React from 'react'; + +import { PinEventAction } from './pin_event_action'; +import { useUserPrivileges } from '../../../../../common/components/user_privileges'; +import { getEndpointPrivilegesInitialStateMock } from '../../../../../common/components/user_privileges/endpoint/mocks'; +import { TestProviders } from '../../../../../common/mock'; +import { TimelineType } from '../../../../../../common/types'; + +jest.mock('../../../../../common/components/user_privileges'); +const useUserPrivilegesMock = useUserPrivileges as jest.Mock; + +describe('PinEventAction', () => { + beforeEach(() => { + jest.resetAllMocks(); + }); + + describe('isDisabled', () => { + test('it disables the pin event button when the user does NOT have crud privileges', () => { + useUserPrivilegesMock.mockReturnValue({ + kibanaSecuritySolutionsPrivileges: { crud: false, read: true }, + endpointPrivileges: getEndpointPrivilegesInitialStateMock(), + }); + + render( + + + + ); + + expect(screen.getByTestId('pin')).toHaveClass('euiButtonIcon-isDisabled'); + }); + + test('it enables the pin event button when the user has crud privileges', () => { + useUserPrivilegesMock.mockReturnValue({ + kibanaSecuritySolutionsPrivileges: { crud: true, read: true }, + endpointPrivileges: getEndpointPrivilegesInitialStateMock(), + }); + + render( + + + + ); + + expect(screen.getByTestId('pin')).not.toHaveClass('euiButtonIcon-isDisabled'); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.tsx index 53970594c8c1c..d0294d3908590 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/actions/pin_event_action.tsx @@ -13,6 +13,7 @@ import { EventsTdContent } from '../../styles'; import { eventHasNotes, getPinTooltip } from '../helpers'; import { Pin } from '../../pin'; import { TimelineType } from '../../../../../../common/types/timeline'; +import { useUserPrivileges } from '../../../../../common/components/user_privileges'; interface PinEventActionProps { ariaLabel?: string; @@ -31,6 +32,7 @@ const PinEventActionComponent: React.FC = ({ eventIsPinned, timelineType, }) => { + const { kibanaSecuritySolutionsPrivileges } = useUserPrivileges(); const tooltipContent = useMemo( () => getPinTooltip({ @@ -50,6 +52,7 @@ const PinEventActionComponent: React.FC = ({ ariaLabel={ariaLabel} allowUnpinning={!eventHasNotes(noteIds)} data-test-subj="pin-event" + isDisabled={kibanaSecuritySolutionsPrivileges.crud === false} isAlert={isAlert} onClick={onPinClicked} pinned={eventIsPinned} diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/events/event_column_view.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/events/event_column_view.test.tsx index 334bd464f700f..59b331d4d7f11 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/events/event_column_view.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/events/event_column_view.test.tsx @@ -28,6 +28,17 @@ jest.mock('../../../../../common/hooks/use_selector', () => ({ useShallowEqualSelector: jest.fn(), useDeepEqualSelector: jest.fn(), })); +jest.mock('../../../../../common/components/user_privileges', () => { + return { + useUserPrivileges: () => ({ + listPrivileges: { loading: false, error: undefined, result: undefined }, + detectionEnginePrivileges: { loading: false, error: undefined, result: undefined }, + endpointPrivileges: {}, + kibanaSecuritySolutionsPrivileges: { crud: true, read: true }, + }), + }; +}); + jest.mock('../../../../../common/lib/kibana', () => ({ useKibana: () => ({ services: { diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/index.test.tsx index 200c9810d9fe6..f2045327a42f7 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/index.test.tsx @@ -36,6 +36,17 @@ import { createStore, State } from '../../../../common/store'; jest.mock('../../../../common/lib/kibana/hooks'); jest.mock('../../../../common/hooks/use_app_toasts'); +jest.mock('../../../../common/components/user_privileges', () => { + return { + useUserPrivileges: () => ({ + listPrivileges: { loading: false, error: undefined, result: undefined }, + detectionEnginePrivileges: { loading: false, error: undefined, result: undefined }, + endpointPrivileges: {}, + kibanaSecuritySolutionsPrivileges: { crud: true, read: true }, + }), + }; +}); + jest.mock('../../../../common/lib/kibana', () => { const originalModule = jest.requireActual('../../../../common/lib/kibana'); const mockCasesContract = jest.requireActual('@kbn/cases-plugin/public/mocks'); @@ -225,7 +236,7 @@ describe('Body', () => { mockDispatch.mockClear(); }); - test('Add a Note to an event', () => { + test('Add a note to an event', () => { const wrapper = mount( @@ -257,7 +268,7 @@ describe('Body', () => { ); }); - test('Add two Note to an event', () => { + test('Add two notes to an event', () => { const { storage } = createSecuritySolutionStorageMock(); const state: State = { ...mockGlobalState, diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/helpers.ts b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/helpers.ts index 7e251ffa5e369..99dc241650bd4 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/helpers.ts +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/helpers.ts @@ -31,5 +31,5 @@ export const hasThreatMatchValue = (data: Ecs): boolean => ); export const HorizontalSpacer = styled.div` - margin: 0 ${({ theme }) => theme.eui.paddingSizes.xs}; + margin: 0 ${({ theme }) => theme.eui.euiSizeXS}; `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/threat_match_rows.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/threat_match_rows.tsx index cc4d3eeee2533..0b76c97a5c17e 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/threat_match_rows.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/body/renderers/cti/threat_match_rows.tsx @@ -18,7 +18,7 @@ import { RowRendererContainer } from '../row_renderer'; import { ThreatMatchRow } from './threat_match_row'; const SpacedContainer = styled.div` - margin: ${({ theme }) => theme.eui.paddingSizes.s} 0; + margin: ${({ theme }) => theme.eui.euiSizeS} 0; `; export const ThreatMatchRows: RowRenderer['renderRow'] = ({ data, isDraggable, timelineId }) => { diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/__snapshots__/empty.test.tsx.snap b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/__snapshots__/empty.test.tsx.snap index 006da47460012..e2c5534f5327a 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/__snapshots__/empty.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/__snapshots__/empty.test.tsx.snap @@ -8,6 +8,7 @@ exports[`Empty rendering renders correctly against snapshot 1`] = ` > @@ -21,6 +22,7 @@ exports[`Empty rendering renders correctly against snapshot 1`] = ` @@ -30,6 +32,7 @@ exports[`Empty rendering renders correctly against snapshot 1`] = ` type="or" /> diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/empty.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/empty.tsx index d5c5332b25053..3f6b1f629217a 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/empty.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/empty.tsx @@ -91,7 +91,7 @@ export const Empty = React.memo(({ showSmallMsg = false, browserFields, t {!showSmallMsg && ( <> - + {i18n.DROP_ANYTHING} @@ -99,11 +99,11 @@ export const Empty = React.memo(({ showSmallMsg = false, browserFields, t {i18n.HIGHLIGHTED} - + {i18n.HERE_TO_BUILD_AN} - + {i18n.QUERY} diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/index.tsx index 0a3a40d8f6f06..758ecafe64d86 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/data_providers/index.tsx @@ -35,7 +35,7 @@ const DropTargetDataProvidersContainer = styled.div` background: ${({ theme }) => rgba(theme.eui.euiColorSuccess, 0.1)}; border: 0.2rem dashed ${({ theme }) => theme.eui.euiColorSuccess}; - & .euiTextColor--subdued { + & .timeline-drop-area-empty__text { color: ${({ theme }) => theme.eui.euiColorSuccess}; } diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/eql_tab_content/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/eql_tab_content/index.tsx index c53871cf2e52b..c9dd9ce76d665 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/eql_tab_content/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/eql_tab_content/index.tsx @@ -130,7 +130,7 @@ const VerticalRule = styled.div` VerticalRule.displayName = 'VerticalRule'; const EventsCountBadge = styled(EuiBadge)` - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; `; const isTimerangeSame = (prevProps: Props, nextProps: Props) => diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/notes_tab_content/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/notes_tab_content/index.tsx index c2179abbb61df..7c25794a16c80 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/notes_tab_content/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/notes_tab_content/index.tsx @@ -39,6 +39,7 @@ import { getTimelineNoteSelector } from './selectors'; import { DetailsPanel } from '../../side_panel'; import { getScrollToTopSelector } from '../tabs_content/selectors'; import { useScrollToTop } from '../../../../common/components/scroll_to_top'; +import { useUserPrivileges } from '../../../../common/components/user_privileges'; const FullWidthFlexGroup = styled(EuiFlexGroup)` width: 100%; @@ -131,6 +132,7 @@ interface NotesTabContentProps { const NotesTabContentComponent: React.FC = ({ timelineId }) => { const dispatch = useDispatch(); + const { kibanaSecuritySolutionsPrivileges } = useUserPrivileges(); const getScrollToTop = useMemo(() => getScrollToTopSelector(), []); const scrollToTop = useShallowEqualSelector((state) => getScrollToTop(state, timelineId)); @@ -239,7 +241,7 @@ const NotesTabContentComponent: React.FC = ({ timelineId } showTimelineDescription /> - {!isImmutable && ( + {!isImmutable && kibanaSecuritySolutionsPrivileges.crud === true && ( void; pinned: boolean; @@ -45,7 +46,7 @@ export const getDefaultAriaLabel = ({ }; export const Pin = React.memo( - ({ ariaLabel, allowUnpinning, isAlert, onClick = noop, pinned, timelineType }) => { + ({ ariaLabel, allowUnpinning, isAlert, isDisabled, onClick = noop, pinned, timelineType }) => { const isTemplate = timelineType === TimelineType.template; const defaultAriaLabel = getDefaultAriaLabel({ isAlert, @@ -60,7 +61,7 @@ export const Pin = React.memo( data-test-subj="pin" iconType={getPinIcon(pinned)} onClick={onClick} - isDisabled={isTemplate || !allowUnpinning} + isDisabled={isDisabled || isTemplate || !allowUnpinning} size="s" /> ); diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/properties/helpers.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/properties/helpers.tsx index c59c0a15ff53d..ff0d8686bb9c3 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/properties/helpers.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/properties/helpers.tsx @@ -91,6 +91,7 @@ NewTimeline.displayName = 'NewTimeline'; interface NotesButtonProps { ariaLabel?: string; + isDisabled?: boolean; showNotes: boolean; toggleShowNotes: () => void; toolTip?: string; @@ -99,6 +100,7 @@ interface NotesButtonProps { interface SmallNotesButtonProps { ariaLabel?: string; + isDisabled?: boolean; toggleShowNotes: () => void; timelineType: TimelineTypeLiteral; } @@ -106,7 +108,7 @@ interface SmallNotesButtonProps { export const NOTES_BUTTON_CLASS_NAME = 'notes-button'; const SmallNotesButton = React.memo( - ({ ariaLabel = i18n.NOTES, toggleShowNotes, timelineType }) => { + ({ ariaLabel = i18n.NOTES, isDisabled, toggleShowNotes, timelineType }) => { const isTemplate = timelineType === TimelineType.template; return ( @@ -114,6 +116,7 @@ const SmallNotesButton = React.memo( aria-label={ariaLabel} className={NOTES_BUTTON_CLASS_NAME} data-test-subj="timeline-notes-button-small" + disabled={isDisabled} iconType="editorComment" onClick={toggleShowNotes} size="s" @@ -125,10 +128,11 @@ const SmallNotesButton = React.memo( SmallNotesButton.displayName = 'SmallNotesButton'; export const NotesButton = React.memo( - ({ ariaLabel, showNotes, timelineType, toggleShowNotes, toolTip }) => + ({ ariaLabel, isDisabled, showNotes, timelineType, toggleShowNotes, toolTip }) => showNotes ? ( @@ -136,6 +140,7 @@ export const NotesButton = React.memo( diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/query_tab_content/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/query_tab_content/index.tsx index 25b7f4a8b636a..771cb52ff1091 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/query_tab_content/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/query_tab_content/index.tsx @@ -137,7 +137,7 @@ const VerticalRule = styled.div` VerticalRule.displayName = 'VerticalRule'; const EventsCountBadge = styled(EuiBadge)` - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; `; const isTimerangeSame = (prevProps: Props, nextProps: Props) => diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/search_or_filter/helpers.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/search_or_filter/helpers.tsx index 23da1c6b74fd5..3e6aff9acca6b 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/search_or_filter/helpers.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/search_or_filter/helpers.tsx @@ -61,7 +61,7 @@ export const options = [ {modes.filter.selectText} -

{modes.filter.description}

+

{modes.filter.description}

 ), @@ -81,7 +81,7 @@ export const options = [ {modes.search.selectText} -

{modes.search.description}

+

{modes.search.description}

 ), diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/styles.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/styles.tsx index 66a21da80bd86..125803b4d1b30 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/styles.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/styles.tsx @@ -195,7 +195,7 @@ export const EventsThContent = styled.div.attrs(({ className = '' }) => ({ font-weight: ${({ theme }) => theme.eui.euiFontWeightSemiBold}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; min-width: 0; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; text-align: ${({ textAlign }) => textAlign}; width: ${({ width }) => width != null @@ -204,7 +204,7 @@ export const EventsThContent = styled.div.attrs(({ className = '' }) => ({ > button.euiButtonIcon, > .euiToolTipAnchor > button.euiButtonIcon { - margin-left: ${({ theme }) => `-${theme.eui.paddingSizes.xs}`}; + margin-left: ${({ theme }) => `-${theme.eui.euiSizeXS}`}; } `; @@ -296,12 +296,12 @@ export const EventsTrSupplement = styled.div.attrs(({ className = '' }) => ({ }))<{ className: string }>` font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; - padding-left: ${({ theme }) => theme.eui.paddingSizes.m}; + padding-left: ${({ theme }) => theme.eui.euiSizeM}; .euiAccordion + div { background-color: ${({ theme }) => theme.eui.euiColorEmptyShade}; - padding: 0 ${({ theme }) => theme.eui.paddingSizes.s}; + padding: 0 ${({ theme }) => theme.eui.euiSizeS}; border: 1px solid ${({ theme }) => theme.eui.euiColorLightShade}; - border-radius: ${({ theme }) => theme.eui.paddingSizes.xs}; + border-radius: ${({ theme }) => theme.eui.euiSizeXS}; } `; @@ -362,7 +362,7 @@ export const EventsTdContent = styled.div.attrs(({ className }) => ({ font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; min-width: 0; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; text-align: ${({ textAlign }) => textAlign}; width: ${({ width }) => width != null @@ -370,7 +370,7 @@ export const EventsTdContent = styled.div.attrs(({ className }) => ({ : '100%'}; /* Using width: 100% instead of flex: 1 and max-width: 100% for IE11 */ button.euiButtonIcon { - margin-left: ${({ theme }) => `-${theme.eui.paddingSizes.xs}`}; + margin-left: ${({ theme }) => `-${theme.eui.euiSizeXS}`}; } `; diff --git a/x-pack/plugins/security_solution/public/timelines/components/timeline/tabs_content/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/timeline/tabs_content/index.tsx index b8b9d73932afd..2ca377c57ce33 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/timeline/tabs_content/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/timeline/tabs_content/index.tsx @@ -214,7 +214,7 @@ const ActiveTimelineTab = memo( ActiveTimelineTab.displayName = 'ActiveTimelineTab'; const CountBadge = styled(EuiBadge)` - margin-left: ${({ theme }) => theme.eui.paddingSizes.s}; + margin-left: ${({ theme }) => theme.eui.euiSizeS}; `; const StyledEuiTab = styled(EuiTab)` diff --git a/x-pack/plugins/security_solution/public/users/pages/navigation/user_risk_tab_body.tsx b/x-pack/plugins/security_solution/public/users/pages/navigation/user_risk_tab_body.tsx index 1684297fd236d..cc0396d634b63 100644 --- a/x-pack/plugins/security_solution/public/users/pages/navigation/user_risk_tab_body.tsx +++ b/x-pack/plugins/security_solution/public/users/pages/navigation/user_risk_tab_body.tsx @@ -24,7 +24,7 @@ import { useDashboardButtonHref } from '../../../common/hooks/use_dashboard_butt const QUERY_ID = UserRiskScoreQueryId.USER_DETAILS_RISK_SCORE; const StyledEuiFlexGroup = styled(EuiFlexGroup)` - margin-top: ${({ theme }) => theme.eui.paddingSizes.l}; + margin-top: ${({ theme }) => theme.eui.euiSizeL}; `; const RISKY_USERS_DASHBOARD_TITLE = 'Current Risk Score For Users'; diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts index 318e479d7116b..e30b982fc2e9b 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/index.ts @@ -8,21 +8,17 @@ import { registerActionDetailsRoutes } from './details'; import { SecuritySolutionPluginRouter } from '../../../types'; import { EndpointAppContext } from '../../types'; -import { registerHostIsolationRoutes } from './isolation'; import { registerActionStatusRoutes } from './status'; import { registerActionAuditLogRoutes } from './audit_log'; import { registerActionListRoutes } from './list'; import { registerResponseActionRoutes } from './response_actions'; -export * from './isolation'; - // wrap route registration export function registerActionRoutes( router: SecuritySolutionPluginRouter, endpointContext: EndpointAppContext ) { - registerHostIsolationRoutes(router, endpointContext); registerActionStatusRoutes(router, endpointContext); registerActionAuditLogRoutes(router, endpointContext); registerActionListRoutes(router, endpointContext); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts deleted file mode 100644 index bd3484a0e7518..0000000000000 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts +++ /dev/null @@ -1,568 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -/* eslint-disable @typescript-eslint/no-explicit-any */ - -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { AwaitedProperties } from '@kbn/utility-types'; -import { - KibanaRequest, - KibanaResponseFactory, - RequestHandler, - RouteConfig, -} from '@kbn/core/server'; -import { - elasticsearchServiceMock, - httpServerMock, - httpServiceMock, - loggingSystemMock, - savedObjectsClientMock, -} from '@kbn/core/server/mocks'; -import { parseExperimentalConfigValue } from '../../../../common/experimental_features'; -import { EndpointAppContextService } from '../../endpoint_app_context_services'; -import { - createMockEndpointAppContextServiceSetupContract, - createMockEndpointAppContextServiceStartContract, - createRouteHandlerContext, -} from '../../mocks'; -import { NoParametersRequestSchema } from '../../../../common/endpoint/schema/actions'; -import { registerHostIsolationRoutes } from './isolation'; -import { createMockConfig } from '../../../lib/detection_engine/routes/__mocks__'; -import { LicenseService } from '../../../../common/license'; -import { Subject } from 'rxjs'; -import { ILicense } from '@kbn/licensing-plugin/common/types'; -import { licenseMock } from '@kbn/licensing-plugin/common/licensing.mock'; -import { License } from '@kbn/licensing-plugin/common/license'; -import { - ISOLATE_HOST_ROUTE, - UNISOLATE_HOST_ROUTE, - metadataTransformPrefix, - ENDPOINT_ACTIONS_INDEX, -} from '../../../../common/endpoint/constants'; -import { - EndpointAction, - HostIsolationRequestBody, - HostIsolationResponse, - HostMetadata, - LogsEndpointAction, -} from '../../../../common/endpoint/types'; -import { EndpointDocGenerator } from '../../../../common/endpoint/generate_data'; -import { legacyMetadataSearchResponseMock } from '../metadata/support/test_support'; -import { AGENT_ACTIONS_INDEX, ElasticsearchAssetType } from '@kbn/fleet-plugin/common'; -import { CasesClientMock } from '@kbn/cases-plugin/server/client/mocks'; -import { EndpointAuthz } from '../../../../common/endpoint/types/authz'; -import type { PackageClient } from '@kbn/fleet-plugin/server'; -import { createMockPackageService } from '@kbn/fleet-plugin/server/mocks'; -import { SecuritySolutionRequestHandlerContextMock } from '../../../lib/detection_engine/routes/__mocks__/request_context'; - -interface CallRouteInterface { - body?: HostIsolationRequestBody; - idxResponse?: any; - searchResponse?: HostMetadata; - mockUser?: any; - license?: License; - authz?: Partial; -} - -const Platinum = licenseMock.createLicense({ license: { type: 'platinum', mode: 'platinum' } }); -const Gold = licenseMock.createLicense({ license: { type: 'gold', mode: 'gold' } }); - -describe('Host Isolation', () => { - describe('schema', () => { - it('should require at least 1 Endpoint ID', () => { - expect(() => { - NoParametersRequestSchema.body.validate({}); - }).toThrow(); - }); - - it('should accept an Endpoint ID as the only required field', () => { - expect(() => { - NoParametersRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - }); - }).not.toThrow(); - }); - - it('should accept a comment', () => { - expect(() => { - NoParametersRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - comment: 'a user comment', - }); - }).not.toThrow(); - }); - - it('should accept alert IDs', () => { - expect(() => { - NoParametersRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - alert_ids: ['0000000-000-00'], - }); - }).not.toThrow(); - }); - - it('should accept case IDs', () => { - expect(() => { - NoParametersRequestSchema.body.validate({ - endpoint_ids: ['ABC-XYZ-000'], - case_ids: ['000000000-000-000'], - }); - }).not.toThrow(); - }); - }); - - describe('handler', () => { - let endpointAppContextService: EndpointAppContextService; - let mockResponse: jest.Mocked; - let licenseService: LicenseService; - let licenseEmitter: Subject; - - let callRoute: ( - routePrefix: string, - opts: CallRouteInterface, - indexExists?: { endpointDsExists: boolean } - ) => Promise>; - const superUser = { - username: 'superuser', - roles: ['superuser'], - }; - - const docGen = new EndpointDocGenerator(); - - beforeEach(() => { - // instantiate... everything - const mockScopedClient = elasticsearchServiceMock.createScopedClusterClient(); - const mockClusterClient = elasticsearchServiceMock.createClusterClient(); - mockClusterClient.asScoped.mockReturnValue(mockScopedClient); - const routerMock = httpServiceMock.createRouter(); - mockResponse = httpServerMock.createResponseFactory(); - const startContract = createMockEndpointAppContextServiceStartContract(); - endpointAppContextService = new EndpointAppContextService(); - const mockSavedObjectClient = savedObjectsClientMock.create(); - const mockPackageService = createMockPackageService(); - const mockedPackageClient = mockPackageService.asInternalUser as jest.Mocked; - mockedPackageClient.getInstallation.mockResolvedValue({ - installed_kibana: [], - package_assets: [], - es_index_patterns: {}, - name: '', - version: '', - install_status: 'installed', - install_version: '', - install_started_at: '', - install_source: 'registry', - installed_es: [ - { - id: 'logs-endpoint.events.security', - type: ElasticsearchAssetType.indexTemplate, - }, - { - id: `${metadataTransformPrefix}-0.16.0-dev.0`, - type: ElasticsearchAssetType.transform, - }, - ], - keep_policies_up_to_date: false, - }); - - licenseEmitter = new Subject(); - licenseService = new LicenseService(); - licenseService.start(licenseEmitter); - - endpointAppContextService.setup(createMockEndpointAppContextServiceSetupContract()); - endpointAppContextService.start({ - ...startContract, - licenseService, - packageService: mockPackageService, - }); - - // add the host isolation route handlers to routerMock - registerHostIsolationRoutes(routerMock, { - logFactory: loggingSystemMock.create(), - service: endpointAppContextService, - config: () => Promise.resolve(createMockConfig()), - experimentalFeatures: parseExperimentalConfigValue(createMockConfig().enableExperimental), - }); - - // define a convenience function to execute an API call for a given route, body, and mocked response from ES - // it returns the requestContext mock used in the call, to assert internal calls (e.g. the indexed document) - callRoute = async ( - routePrefix: string, - { body, idxResponse, searchResponse, mockUser, license, authz = {} }: CallRouteInterface, - indexExists?: { endpointDsExists: boolean } - ): Promise> => { - const asUser = mockUser ? mockUser : superUser; - (startContract.security.authc.getCurrentUser as jest.Mock).mockImplementationOnce( - () => asUser - ); - - const ctx = createRouteHandlerContext(mockScopedClient, mockSavedObjectClient); - - ctx.securitySolution.endpointAuthz = { - ...ctx.securitySolution.endpointAuthz, - ...authz, - }; - - // mock _index_template - ctx.core.elasticsearch.client.asInternalUser.indices.existsIndexTemplate.mockResponseImplementationOnce( - () => { - if (indexExists) { - return { - body: true, - statusCode: 200, - }; - } - return { - body: false, - statusCode: 404, - }; - } - ); - - const withIdxResp = idxResponse ? idxResponse : { statusCode: 201 }; - ctx.core.elasticsearch.client.asInternalUser.index.mockResponseImplementation( - () => withIdxResp - ); - ctx.core.elasticsearch.client.asCurrentUser.search.mockResponseImplementation(() => { - return { - body: legacyMetadataSearchResponseMock(searchResponse), - }; - }); - - const withLicense = license ? license : Platinum; - licenseEmitter.next(withLicense); - - const mockRequest = httpServerMock.createKibanaRequest({ body }); - const [, routeHandler]: [ - RouteConfig, - RequestHandler - ] = routerMock.post.mock.calls.find(([{ path }]) => path.startsWith(routePrefix))!; - - await routeHandler(ctx, mockRequest, mockResponse); - - return ctx; - }; - }); - - afterEach(() => { - endpointAppContextService.stop(); - licenseService.stop(); - licenseEmitter.complete(); - }); - it('succeeds when an endpoint ID is provided', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); - expect(mockResponse.ok).toBeCalled(); - }); - it('reports elasticsearch errors creating an action', async () => { - const ErrMessage = 'something went wrong?'; - - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - idxResponse: { - statusCode: 500, - body: { - result: ErrMessage, - }, - }, - }); - expect(mockResponse.ok).not.toBeCalled(); - const response = mockResponse.customError.mock.calls[0][0]; - expect(response.statusCode).toEqual(500); - expect((response.body as Error).message).toEqual(ErrMessage); - }); - it('accepts a comment field', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'], comment: 'XYZ' } }); - expect(mockResponse.ok).toBeCalled(); - }); - it('sends the action to the requested agent', async () => { - const metadataResponse = docGen.generateHostMetadata(); - const AgentID = metadataResponse.elastic.agent.id; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['ABC-XYZ-000'] }, - searchResponse: metadataResponse, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.agents).toContain(AgentID); - }); - it('records the user who performed the action to the action record', async () => { - const testU = { username: 'testuser', roles: ['superuser'] }; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - mockUser: testU, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.user_id).toEqual(testU.username); - }); - it('records the comment in the action payload', async () => { - const CommentText = "I am isolating this because it's Friday"; - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], comment: CommentText }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.comment).toEqual(CommentText); - }); - it('creates an action and returns its ID', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], comment: 'XYZ' }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - const actionID = actionDoc.action_id; - expect(mockResponse.ok).toBeCalled(); - expect((mockResponse.ok.mock.calls[0][0]?.body as HostIsolationResponse).action).toEqual( - actionID - ); - }); - it('records the timeout in the action payload', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.timeout).toEqual(300); - }); - it('sends the action to the correct agent when endpoint ID is given', async () => { - const doc = docGen.generateHostMetadata(); - const AgentID = doc.elastic.agent.id; - - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - searchResponse: doc, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.agents).toContain(AgentID); - }); - - it('sends the isolate command payload from the isolate route', async () => { - const ctx = await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.command).toEqual('isolate'); - }); - it('sends the unisolate command payload from the unisolate route', async () => { - const ctx = await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - const actionDoc: EndpointAction = ( - ctx.core.elasticsearch.client.asInternalUser.index.mock - .calls[0][0] as estypes.IndexRequest - ).body!; - expect(actionDoc.data.command).toEqual('unisolate'); - }); - - describe('With endpoint data streams', () => { - it('handles unisolation', async () => { - const ctx = await callRoute( - UNISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - }, - { endpointDsExists: true } - ); - - const indexDoc = ctx.core.elasticsearch.client.asInternalUser.index; - const actionDocs: [ - { index: string; body?: LogsEndpointAction }, - { index: string; body?: EndpointAction } - ] = [ - indexDoc.mock.calls[0][0] as estypes.IndexRequest, - indexDoc.mock.calls[1][0] as estypes.IndexRequest, - ]; - - expect(actionDocs[0].index).toEqual(ENDPOINT_ACTIONS_INDEX); - expect(actionDocs[1].index).toEqual(AGENT_ACTIONS_INDEX); - expect(actionDocs[0].body!.EndpointActions.data.command).toEqual('unisolate'); - expect(actionDocs[1].body!.data.command).toEqual('unisolate'); - }); - - it('handles isolation', async () => { - const ctx = await callRoute( - ISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - }, - { endpointDsExists: true } - ); - const indexDoc = ctx.core.elasticsearch.client.asInternalUser.index; - const actionDocs: [ - { index: string; body?: LogsEndpointAction }, - { index: string; body?: EndpointAction } - ] = [ - indexDoc.mock.calls[0][0] as estypes.IndexRequest, - indexDoc.mock.calls[1][0] as estypes.IndexRequest, - ]; - - expect(actionDocs[0].index).toEqual(ENDPOINT_ACTIONS_INDEX); - expect(actionDocs[1].index).toEqual(AGENT_ACTIONS_INDEX); - expect(actionDocs[0].body!.EndpointActions.data.command).toEqual('isolate'); - expect(actionDocs[1].body!.data.command).toEqual('isolate'); - }); - - it('handles errors', async () => { - const ErrMessage = 'Uh oh!'; - await callRoute( - UNISOLATE_HOST_ROUTE, - { - body: { endpoint_ids: ['XYZ'] }, - idxResponse: { - statusCode: 500, - body: { - result: ErrMessage, - }, - }, - }, - { endpointDsExists: true } - ); - - expect(mockResponse.ok).not.toBeCalled(); - const response = mockResponse.customError.mock.calls[0][0]; - expect(response.statusCode).toEqual(500); - expect((response.body as Error).message).toEqual(ErrMessage); - }); - }); - - describe('License Level', () => { - it('allows platinum license levels to isolate hosts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - license: Platinum, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('prohibits isolating hosts if no authz for it', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canIsolateHost: false }, - license: Gold, - }); - - expect(mockResponse.forbidden).toBeCalled(); - }); - - it('allows any license level to unisolate', async () => { - licenseEmitter.next(Gold); - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - license: Gold, - }); - expect(mockResponse.ok).toBeCalled(); - }); - }); - - describe('User Authorization Level', () => { - it('allows user to perform isolation when canIsolateHost is true', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('allows user to perform unisolation when canUnIsolateHost is true', async () => { - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - }); - expect(mockResponse.ok).toBeCalled(); - }); - - it('prohibits user from performing isolation if canIsolateHost is false', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canIsolateHost: false }, - }); - expect(mockResponse.forbidden).toBeCalled(); - }); - - it('prohibits user from performing un-isolation if canUnIsolateHost is false', async () => { - await callRoute(UNISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'] }, - authz: { canUnIsolateHost: false }, - }); - expect(mockResponse.forbidden).toBeCalled(); - }); - }); - - describe('Cases', () => { - let casesClient: CasesClientMock; - - const getCaseIdsFromAttachmentAddService = () => { - return casesClient.attachments.add.mock.calls.map(([addArgs]) => addArgs.caseId); - }; - - beforeEach(async () => { - casesClient = (await endpointAppContextService.getCasesClient( - {} as KibanaRequest - )) as CasesClientMock; - - let counter = 1; - casesClient.cases.getCasesByAlertID.mockImplementation(async () => { - return [ - { - id: `case-${counter++}`, - title: 'case', - }, - ]; - }); - }); - - it('logs a comment to the provided cases', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], case_ids: ['one', 'two'] }, - }); - - expect(casesClient.attachments.add).toHaveBeenCalledTimes(2); - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['one', 'two']) - ); - }); - - it('logs a comment to any cases associated with the given alerts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - body: { endpoint_ids: ['XYZ'], alert_ids: ['one', 'two'] }, - }); - - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['case-1', 'case-2']) - ); - }); - - it('logs a comment to any cases provided on input along with cases associated with the given alerts', async () => { - await callRoute(ISOLATE_HOST_ROUTE, { - // 'case-1` provided on `case_ids` should be dedupped - body: { - endpoint_ids: ['XYZ'], - case_ids: ['ONE', 'TWO', 'case-1'], - alert_ids: ['one', 'two'], - }, - }); - - expect(casesClient.attachments.add).toHaveBeenCalledTimes(4); - expect(getCaseIdsFromAttachmentAddService()).toEqual( - expect.arrayContaining(['ONE', 'TWO', 'case-1', 'case-2']) - ); - }); - }); - }); -}); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts deleted file mode 100644 index bd0e3f07ce6a8..0000000000000 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.ts +++ /dev/null @@ -1,294 +0,0 @@ -/* - * 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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import moment from 'moment'; -import { RequestHandler, Logger } from '@kbn/core/server'; -import uuid from 'uuid'; -import { TypeOf } from '@kbn/config-schema'; -import { CommentType } from '@kbn/cases-plugin/common'; -import { CasesByAlertId } from '@kbn/cases-plugin/common/api/cases/case'; -import { AGENT_ACTIONS_INDEX } from '@kbn/fleet-plugin/common'; -import { NoParametersRequestSchema } from '../../../../common/endpoint/schema/actions'; -import { - ENDPOINT_ACTIONS_DS, - ENDPOINT_ACTION_RESPONSES_DS, - ISOLATE_HOST_ROUTE, - UNISOLATE_HOST_ROUTE, - failedFleetActionErrorCode, -} from '../../../../common/endpoint/constants'; -import { - EndpointAction, - HostMetadata, - LogsEndpointAction, - LogsEndpointActionResponse, -} from '../../../../common/endpoint/types'; -import { - SecuritySolutionPluginRouter, - SecuritySolutionRequestHandlerContext, -} from '../../../types'; -import { getMetadataForEndpoints } from '../../services'; -import { EndpointAppContext } from '../../types'; -import { APP_ID } from '../../../../common/constants'; -import { doLogsEndpointActionDsExists } from '../../utils'; -import { withEndpointAuthz } from '../with_endpoint_authz'; - -/** - * Registers the Host-(un-)isolation routes - */ -export function registerHostIsolationRoutes( - router: SecuritySolutionPluginRouter, - endpointContext: EndpointAppContext -) { - const logger = endpointContext.logFactory.get('hostIsolation'); - - // perform isolation - router.post( - { - path: ISOLATE_HOST_ROUTE, - validate: NoParametersRequestSchema, - options: { authRequired: true, tags: ['access:securitySolution'] }, - }, - withEndpointAuthz( - { all: ['canIsolateHost'] }, - logger, - isolationRequestHandler(endpointContext, true) - ) - ); - - // perform UN-isolate - router.post( - { - path: UNISOLATE_HOST_ROUTE, - validate: NoParametersRequestSchema, - options: { authRequired: true, tags: ['access:securitySolution'] }, - }, - withEndpointAuthz( - { all: ['canUnIsolateHost'] }, - logger, - isolationRequestHandler(endpointContext, false) - ) - ); -} - -const createFailedActionResponseEntry = async ({ - context, - doc, - logger, -}: { - context: SecuritySolutionRequestHandlerContext; - doc: LogsEndpointActionResponse; - logger: Logger; -}): Promise => { - // 8.0+ requires internal user to write to system indices - const esClient = (await context.core).elasticsearch.client.asInternalUser; - try { - await esClient.index({ - index: `${ENDPOINT_ACTION_RESPONSES_DS}-default`, - body: { - ...doc, - error: { - code: failedFleetActionErrorCode, - message: 'Failed to deliver action request to fleet', - }, - }, - }); - } catch (e) { - logger.error(e); - } -}; - -export const isolationRequestHandler = function ( - endpointContext: EndpointAppContext, - isolate: boolean -): RequestHandler< - unknown, - unknown, - TypeOf, - SecuritySolutionRequestHandlerContext -> { - return async (context, req, res) => { - endpointContext.service.getFeatureUsageService().notifyUsage('HOST_ISOLATION'); - const user = endpointContext.service.security?.authc.getCurrentUser(req); - - // fetch the Agent IDs to send the commands to - const endpointIDs = [...new Set(req.body.endpoint_ids)]; // dedupe - const endpointData = await getMetadataForEndpoints(endpointIDs, context); - - const casesClient = await endpointContext.service.getCasesClient(req); - - // convert any alert IDs into cases - let caseIDs: string[] = req.body.case_ids?.slice() || []; - if (req.body.alert_ids && req.body.alert_ids.length > 0) { - const newIDs: string[][] = await Promise.all( - req.body.alert_ids.map(async (a: string) => { - const cases: CasesByAlertId = await casesClient.cases.getCasesByAlertID({ - alertID: a, - options: { owner: APP_ID }, - }); - return cases.map((caseInfo): string => { - return caseInfo.id; - }); - }) - ); - caseIDs = caseIDs.concat(...newIDs); - } - caseIDs = [...new Set(caseIDs)]; - - // create an Action ID and dispatch it to ES & Fleet Server - const actionID = uuid.v4(); - - let fleetActionIndexResult; - let logsEndpointActionsResult; - - const agents = endpointData.map((endpoint: HostMetadata) => endpoint.elastic.agent.id); - const doc = { - '@timestamp': moment().toISOString(), - agent: { - id: agents, - }, - EndpointActions: { - action_id: actionID, - expiration: moment().add(2, 'weeks').toISOString(), - type: 'INPUT_ACTION', - input_type: 'endpoint', - data: { - command: isolate ? 'isolate' : 'unisolate', - comment: req.body.comment ?? undefined, - }, - } as Omit, - user: { - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - id: user!.username, - }, - }; - - // if .logs-endpoint.actions data stream exists - // try to create action request record in .logs-endpoint.actions DS as the current user - // (from >= v7.16, use this check to ensure the current user has privileges to write to the new index) - // and allow only users with superuser privileges to write to fleet indices - const logger = endpointContext.logFactory.get('host-isolation'); - const doesLogsEndpointActionsDsExist = await doLogsEndpointActionDsExists({ - context, - logger, - dataStreamName: ENDPOINT_ACTIONS_DS, - }); - - // 8.0+ requires internal user to write to system indices - const esClient = (await context.core).elasticsearch.client.asInternalUser; - - // if the new endpoint indices/data streams exists - // write the action request to the new endpoint index - if (doesLogsEndpointActionsDsExist) { - try { - logsEndpointActionsResult = await esClient.index( - { - index: `${ENDPOINT_ACTIONS_DS}-default`, - body: { - ...doc, - }, - refresh: 'wait_for', - }, - { meta: true } - ); - if (logsEndpointActionsResult.statusCode !== 201) { - return res.customError({ - statusCode: 500, - body: { - message: logsEndpointActionsResult.body.result, - }, - }); - } - } catch (e) { - return res.customError({ - statusCode: 500, - body: { message: e }, - }); - } - } - - // write actions to .fleet-actions index - try { - fleetActionIndexResult = await esClient.index( - { - index: AGENT_ACTIONS_INDEX, - body: { - ...doc.EndpointActions, - '@timestamp': doc['@timestamp'], - agents, - timeout: 300, // 5 minutes - user_id: doc.user.id, - }, - refresh: 'wait_for', - }, - { meta: true } - ); - - if (fleetActionIndexResult.statusCode !== 201) { - return res.customError({ - statusCode: 500, - body: { - message: fleetActionIndexResult.body.result, - }, - }); - } - } catch (e) { - // create entry in .logs-endpoint.action.responses-default data stream - // when writing to .fleet-actions fails - if (doesLogsEndpointActionsDsExist) { - await createFailedActionResponseEntry({ - context, - doc: { - '@timestamp': moment().toISOString(), - agent: doc.agent, - EndpointActions: { - action_id: doc.EndpointActions.action_id, - completed_at: moment().toISOString(), - started_at: moment().toISOString(), - data: doc.EndpointActions.data, - }, - }, - logger, - }); - } - return res.customError({ - statusCode: 500, - body: { message: e }, - }); - } - - // Update all cases with a comment - if (caseIDs.length > 0) { - const targets = endpointData.map((endpt: HostMetadata) => ({ - hostname: endpt.host.hostname, - endpointId: endpt.agent.id, - })); - - await Promise.all( - caseIDs.map((caseId) => - casesClient.attachments.add({ - caseId, - comment: { - type: CommentType.actions, - comment: req.body.comment || '', - actions: { - targets, - type: isolate ? 'isolate' : 'unisolate', - }, - owner: APP_ID, - }, - }) - ) - ); - } - - return res.ok({ - body: { - action: actionID, - }, - }); - }; -}; diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts index bbcb549f55f74..c91d000f8341c 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts @@ -35,12 +35,14 @@ import { parseExperimentalConfigValue } from '../../../../common/experimental_fe import { LicenseService } from '../../../../common/license'; import { ISOLATE_HOST_ROUTE_V2, - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, metadataTransformPrefix, ENDPOINT_ACTIONS_INDEX, KILL_PROCESS_ROUTE, SUSPEND_PROCESS_ROUTE, GET_RUNNING_PROCESSES_ROUTE, + ISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE, } from '../../../../common/endpoint/constants'; import { ActionDetails, @@ -221,6 +223,22 @@ describe('Response actions', () => { getActionDetailsByIdSpy.mockClear(); }); + it('correctly redirects legacy isolate to new route', async () => { + await callRoute(ISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); + expect(mockResponse.custom).toBeCalled(); + const response = mockResponse.custom.mock.calls[0][0]; + expect(response.statusCode).toEqual(308); + expect(response.headers?.location).toEqual(ISOLATE_HOST_ROUTE_V2); + }); + + it('correctly redirects legacy release to new route', async () => { + await callRoute(UNISOLATE_HOST_ROUTE, { body: { endpoint_ids: ['XYZ'] } }); + expect(mockResponse.custom).toBeCalled(); + const response = mockResponse.custom.mock.calls[0][0]; + expect(response.statusCode).toEqual(308); + expect(response.headers?.location).toEqual(UNISOLATE_HOST_ROUTE_V2); + }); + it('succeeds when an endpoint ID is provided', async () => { await callRoute(ISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] } }); expect(mockResponse.ok).toBeCalled(); @@ -350,7 +368,7 @@ describe('Response actions', () => { }); it('sends the unisolate command payload from the unisolate route', async () => { - const ctx = await callRoute(RELEASE_HOST_ROUTE, { + const ctx = await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }); const actionDoc: EndpointAction = ( @@ -396,7 +414,7 @@ describe('Response actions', () => { describe('With endpoint data streams', () => { it('handles unisolation', async () => { const ctx = await callRoute( - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }, @@ -537,7 +555,7 @@ describe('Response actions', () => { it('handles errors', async () => { const ErrMessage = 'Uh oh!'; await callRoute( - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, idxResponse: { @@ -578,7 +596,7 @@ describe('Response actions', () => { it('allows any license level to unisolate', async () => { licenseEmitter.next(Gold); - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, license: Gold, }); @@ -595,7 +613,7 @@ describe('Response actions', () => { }); it('allows user to perform unisolation when canUnIsolateHost is true', async () => { - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, }); expect(mockResponse.ok).toBeCalled(); @@ -610,7 +628,7 @@ describe('Response actions', () => { }); it('prohibits user from performing un-isolation if canUnIsolateHost is false', async () => { - await callRoute(RELEASE_HOST_ROUTE, { + await callRoute(UNISOLATE_HOST_ROUTE_V2, { body: { endpoint_ids: ['XYZ'] }, authz: { canUnIsolateHost: false }, }); diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts index 71c61d8aacce8..5d024488d4958 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts @@ -22,13 +22,15 @@ import { import { APP_ID } from '../../../../common/constants'; import { ISOLATE_HOST_ROUTE_V2, - RELEASE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, ENDPOINT_ACTIONS_DS, ENDPOINT_ACTION_RESPONSES_DS, failedFleetActionErrorCode, KILL_PROCESS_ROUTE, SUSPEND_PROCESS_ROUTE, GET_RUNNING_PROCESSES_ROUTE, + ISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE, } from '../../../../common/endpoint/constants'; import type { EndpointAction, @@ -56,6 +58,34 @@ export function registerResponseActionRoutes( ) { const logger = endpointContext.logFactory.get('hostIsolation'); + /** + * @deprecated use ISOLATE_HOST_ROUTE_V2 instead + */ + router.post( + { + path: ISOLATE_HOST_ROUTE, + validate: NoParametersRequestSchema, + options: { authRequired: true, tags: ['access:securitySolution'] }, + }, + withEndpointAuthz({ all: ['canIsolateHost'] }, logger, redirectHandler(ISOLATE_HOST_ROUTE_V2)) + ); + + /** + * @deprecated use RELEASE_HOST_ROUTE instead + */ + router.post( + { + path: UNISOLATE_HOST_ROUTE, + validate: NoParametersRequestSchema, + options: { authRequired: true, tags: ['access:securitySolution'] }, + }, + withEndpointAuthz( + { all: ['canUnIsolateHost'] }, + logger, + redirectHandler(UNISOLATE_HOST_ROUTE_V2) + ) + ); + router.post( { path: ISOLATE_HOST_ROUTE_V2, @@ -71,7 +101,7 @@ export function registerResponseActionRoutes( router.post( { - path: RELEASE_HOST_ROUTE, + path: UNISOLATE_HOST_ROUTE_V2, validate: NoParametersRequestSchema, options: { authRequired: true, tags: ['access:securitySolution'] }, }, @@ -364,3 +394,19 @@ const createFailedActionResponseEntry = async ({ logger.error(e); } }; + +function redirectHandler( + location: string +): RequestHandler< + unknown, + unknown, + TypeOf, + SecuritySolutionRequestHandlerContext +> { + return async (_context, _req, res) => { + return res.custom({ + statusCode: 308, + headers: { location }, + }); + }; +} diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts index 920d9a85ed484..c2db0e00a1400 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts @@ -13,6 +13,7 @@ import { getExistingPrepackagedTimelines, getAllTimeline, resolveTimelineOrNull, + updatePartialSavedTimeline, } from '.'; import { convertSavedObjectToSavedTimeline } from './convert_saved_object_to_savedtimeline'; import { getNotesByTimelineId } from '../notes/saved_object'; @@ -20,6 +21,7 @@ import { getAllPinnedEventsByTimelineId } from '../pinned_events'; import { AllTimelinesResponse, ResolvedTimelineWithOutcomeSavedObject, + SavedTimeline, } from '../../../../../common/types/timeline'; import { mockResolvedSavedObject, @@ -28,6 +30,7 @@ import { } from '../../__mocks__/resolve_timeline'; import { DATA_VIEW_ID_REF_NAME, SAVED_QUERY_ID_REF_NAME, SAVED_QUERY_TYPE } from '../../constants'; import { DATA_VIEW_SAVED_OBJECT_TYPE } from '@kbn/data-views-plugin/common'; +import { SavedObjectsUpdateResponse } from '@kbn/core/server'; jest.mock('./convert_saved_object_to_savedtimeline', () => ({ convertSavedObjectToSavedTimeline: jest.fn(), @@ -360,4 +363,60 @@ describe('saved_object', () => { expect(attributes.savedQueryId).toEqual('boo'); }); }); + + describe('updatePartialSavedTimeline', () => { + let mockSOClientGet: jest.Mock; + let mockSOClientUpdate: jest.Mock; + let mockRequest: FrameworkRequest; + + const patchTimelineRequest: SavedTimeline = { + savedQueryId: null, + }; + + beforeEach(() => { + jest.clearAllMocks(); + + mockSOClientUpdate = jest.fn(() => ({ + ...mockResolvedSavedObject.saved_object, + attributes: {}, + })); + + mockSOClientGet = jest.fn(async () => ({ + ...mockResolvedSavedObject.saved_object, + references: [ + { + id: 'boo', + name: SAVED_QUERY_ID_REF_NAME, + type: SAVED_QUERY_TYPE, + }, + ], + })); + + mockRequest = { + user: { + username: 'username', + }, + context: { + core: { + savedObjects: { + client: { + get: mockSOClientGet, + update: mockSOClientUpdate, + }, + }, + }, + }, + } as unknown as FrameworkRequest; + }); + + it('does not remove savedQueryId when it is null in the patch request', async () => { + const resp = (await updatePartialSavedTimeline( + mockRequest, + '760d3d20-2142-11ec-a46f-051cb8e3154c', + patchTimelineRequest + )) as SavedObjectsUpdateResponse; + + expect(resp.attributes.savedQueryId).toBeNull(); + }); + }); }); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts index de7c31fb47a98..03b16c3292b7e 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts @@ -493,7 +493,7 @@ const updateTimeline = async ({ }; }; -const updatePartialSavedTimeline = async ( +export const updatePartialSavedTimeline = async ( request: FrameworkRequest, timelineId: string, timeline: SavedTimeline @@ -528,7 +528,7 @@ const updatePartialSavedTimeline = async ( const populatedTimeline = timelineFieldsMigrator.populateFieldsFromReferencesForPatch({ - dataBeforeRequest: timelineUpdateAttributes, + dataBeforeRequest: timeline, dataReturnedFromRequest: updatedTimeline, }); diff --git a/x-pack/plugins/session_view/public/components/detail_panel_copy/__snapshots__/index.test.tsx.snap b/x-pack/plugins/session_view/public/components/detail_panel_copy/__snapshots__/index.test.tsx.snap index ea9f03408af67..a9942e3fa968c 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_copy/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/session_view/public/components/detail_panel_copy/__snapshots__/index.test.tsx.snap @@ -6,7 +6,7 @@ Object { "baseElement":
, "container":
{ expect(renderResult.queryByText(TEST_NAME)).toBeVisible(); // expand host os accordion - renderResult.queryByText('Host OS')?.querySelector('button')?.click(); + renderResult.queryByText('Host OS')?.click(); expect(renderResult.queryByText('architecture')).toBeVisible(); expect(renderResult.queryByText('os.family')).toBeVisible(); expect(renderResult.queryByText('os.full')).toBeVisible(); @@ -158,7 +158,7 @@ describe('DetailPanelMetadataTab component', () => { expect(renderResult.queryAllByText('name').length).toBe(2); // expand host os accordion - renderResult.queryByText('Host OS')?.querySelector('button')?.click(); + renderResult.queryByText('Host OS')?.click(); expect(renderResult.queryByText('architecture')).toBeVisible(); expect(renderResult.queryByText('os.family')).toBeVisible(); expect(renderResult.queryByText('os.full')).toBeVisible(); @@ -175,7 +175,7 @@ describe('DetailPanelMetadataTab component', () => { expect(renderResult.queryByText(TEST_OS_VERSION)).toBeVisible(); // expand Container Accordion - renderResult.queryByText('Container')?.querySelector('button')?.click(); + renderResult.queryByText('Container')?.click(); expect(renderResult.queryByText('image.name')).toBeVisible(); expect(renderResult.queryByText('image.tag')).toBeVisible(); expect(renderResult.queryByText('image.hash.all')).toBeVisible(); @@ -186,7 +186,7 @@ describe('DetailPanelMetadataTab component', () => { expect(renderResult.queryByText(TEST_CONTAINER_IMAGE_HASH_ALL)).toBeVisible(); // expand Orchestrator Accordion - renderResult.queryByText('Orchestrator')?.querySelector('button')?.click(); + renderResult.queryByText('Orchestrator')?.click(); expect(renderResult.queryByText('resource.name')).toBeVisible(); expect(renderResult.queryByText('resource.type')).toBeVisible(); expect(renderResult.queryByText('resource.ip')).toBeVisible(); diff --git a/x-pack/plugins/session_view/public/components/process_tree_alert/__snapshots__/index.test.tsx.snap b/x-pack/plugins/session_view/public/components/process_tree_alert/__snapshots__/index.test.tsx.snap index 898da00b7852d..58fae57fefc29 100644 --- a/x-pack/plugins/session_view/public/components/process_tree_alert/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/session_view/public/components/process_tree_alert/__snapshots__/index.test.tsx.snap @@ -42,7 +42,7 @@ Object { class="euiFlexItem euiFlexItem--flexGrowZero" >
cmd test alert
@@ -127,7 +127,7 @@ Object { class="euiFlexItem euiFlexItem--flexGrowZero" >
cmd test alert
diff --git a/x-pack/plugins/session_view/public/components/session_view_search_bar/styles.ts b/x-pack/plugins/session_view/public/components/session_view_search_bar/styles.ts index 6e7c717e2816b..3585c49de75fb 100644 --- a/x-pack/plugins/session_view/public/components/session_view_search_bar/styles.ts +++ b/x-pack/plugins/session_view/public/components/session_view_search_bar/styles.ts @@ -31,7 +31,7 @@ export const useStyles = ({ hasSearchResults }: StylesDeps) => { const noResults: CSSObject = { position: 'absolute', - color: euiTheme.colors.subdued, + color: euiTheme.colors.subduedText, top: euiTheme.size.m, right: euiTheme.size.xxl, }; diff --git a/x-pack/plugins/snapshot_restore/public/application/sections/home/restore_list/restore_list.tsx b/x-pack/plugins/snapshot_restore/public/application/sections/home/restore_list/restore_list.tsx index 3ce492031b866..5b05cb772b478 100644 --- a/x-pack/plugins/snapshot_restore/public/application/sections/home/restore_list/restore_list.tsx +++ b/x-pack/plugins/snapshot_restore/public/application/sections/home/restore_list/restore_list.tsx @@ -115,7 +115,7 @@ export const RestoreList: React.FunctionComponent = () => { +

{ {header} -

+

ID: {destination.id}
Last updated: {lastUpdated} diff --git a/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx b/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx index 5b1182c99029d..4c3767b738f90 100644 --- a/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx +++ b/x-pack/plugins/spaces/public/space_selector/components/space_card.tsx @@ -7,7 +7,7 @@ import './space_card.scss'; -import { EuiCard, EuiLoadingSpinner } from '@elastic/eui'; +import { EuiCard, EuiLoadingSpinner, EuiTextColor } from '@elastic/eui'; import React, { lazy, Suspense } from 'react'; import type { Space } from '../../../common'; @@ -56,8 +56,8 @@ function renderSpaceDescription(space: Space) { } return ( - + {description} - + ); } diff --git a/x-pack/plugins/stack_alerts/public/alert_types/components/index_select_popover.test.tsx b/x-pack/plugins/stack_alerts/public/alert_types/components/index_select_popover.test.tsx index d36c0016ca8d8..b9f27d1255796 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/components/index_select_popover.test.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/components/index_select_popover.test.tsx @@ -92,7 +92,7 @@ describe('IndexSelectPopover', () => { expect(wrapper.find('[data-test-subj="thresholdIndexesComboBox"]').exists()).toBeFalsy(); expect(wrapper.find('[data-test-subj="thresholdAlertTimeFieldSelect"]').exists()).toBeFalsy(); - wrapper.find('[data-test-subj="selectIndexExpression"]').first().simulate('click'); + wrapper.find('[data-test-subj="selectIndexExpression"]').last().simulate('click'); await act(async () => { await nextTick(); wrapper.update(); @@ -106,7 +106,7 @@ describe('IndexSelectPopover', () => { const wrapper = mountWithIntl(); expect(wrapper.find('[data-test-subj="selectIndexExpression"]').exists()).toBeTruthy(); - wrapper.find('[data-test-subj="selectIndexExpression"]').first().simulate('click'); + wrapper.find('[data-test-subj="selectIndexExpression"]').last().simulate('click'); await act(async () => { await nextTick(); wrapper.update(); @@ -166,7 +166,7 @@ describe('IndexSelectPopover', () => { `index ${index}` ); - wrapper.find('[data-test-subj="selectIndexExpression"]').first().simulate('click'); + wrapper.find('[data-test-subj="selectIndexExpression"]').last().simulate('click'); await act(async () => { await nextTick(); wrapper.update(); diff --git a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/__snapshots__/entity_by_expression.test.tsx.snap b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/__snapshots__/entity_by_expression.test.tsx.snap index 8f59fdd7df000..ae7a2b6121ba8 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/__snapshots__/entity_by_expression.test.tsx.snap +++ b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/__snapshots__/entity_by_expression.test.tsx.snap @@ -1,171 +1,30 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`should render entity by expression with aggregatable field options for entity 1`] = ` - - - - - } - value="FlightNum" +

- - } - closePopover={[Function]} - display="block" - hasArrow={true} - id="popoverForExpression" - isOpen={false} - ownFocus={true} - panelPaddingSize="m" - zIndex={8000} + - -
-

- - - + FlightNum + + +
+
`; diff --git a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.test.tsx b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.test.tsx index 322700209d4d2..7d1ef64448311 100644 --- a/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.test.tsx +++ b/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.test.tsx @@ -75,7 +75,7 @@ const defaultProps = { test('should render entity by expression with aggregatable field options for entity', async () => { const component = mount(); - expect(component).toMatchSnapshot(); + expect(component.render()).toMatchSnapshot(); }); // diff --git a/x-pack/plugins/synthetics/common/constants/client_defaults.ts b/x-pack/plugins/synthetics/common/constants/client_defaults.ts index a8860dcca4a1a..5293205a183cb 100644 --- a/x-pack/plugins/synthetics/common/constants/client_defaults.ts +++ b/x-pack/plugins/synthetics/common/constants/client_defaults.ts @@ -5,6 +5,8 @@ * 2.0. */ +import moment from 'moment'; + export const CLIENT_DEFAULTS = { ABSOLUTE_DATE_RANGE_START: 0, // 15 minutes @@ -43,3 +45,17 @@ export const CLIENT_DEFAULTS = { }; export const EXCLUDE_RUN_ONCE_FILTER = { bool: { must_not: { exists: { field: 'run_once' } } } }; +export const SUMMARY_FILTER = { + exists: { + field: 'summary', + }, +}; + +export const getTimeSpanFilter = () => ({ + range: { + 'monitor.timespan': { + lte: moment().toISOString(), + gte: moment().subtract(5, 'minutes').toISOString(), + }, + }, +}); diff --git a/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts index d91342cdedbb0..f054e15e744f7 100644 --- a/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts +++ b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts @@ -72,7 +72,7 @@ export const DEFAULT_BROWSER_SIMPLE_FIELDS: BrowserSimpleFields = { }, [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, [ConfigKey.PARAMS]: '', - [ConfigKey.PORT]: undefined, + [ConfigKey.PORT]: null, [ConfigKey.SCHEDULE]: { unit: ScheduleUnit.MINUTES, number: '10', diff --git a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts index c44d7adced16a..958fc0a5c0a17 100644 --- a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts +++ b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts @@ -229,8 +229,8 @@ export const BrowserSensitiveSimpleFieldsCodec = t.intersection([ [ConfigKey.SOURCE_ZIP_USERNAME]: t.string, [ConfigKey.SOURCE_ZIP_PASSWORD]: t.string, [ConfigKey.PARAMS]: t.string, - [ConfigKey.URLS]: t.union([t.string, t.undefined]), - [ConfigKey.PORT]: t.union([t.number, t.undefined]), + [ConfigKey.URLS]: t.union([t.string, t.null]), + [ConfigKey.PORT]: t.union([t.number, t.null]), }), ZipUrlTLSFieldsCodec, CommonFieldsCodec, diff --git a/x-pack/plugins/synthetics/e2e/journeys/data_view_permissions.ts b/x-pack/plugins/synthetics/e2e/journeys/data_view_permissions.ts index 10e027f249104..b265da7a3f0d6 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/data_view_permissions.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/data_view_permissions.ts @@ -38,7 +38,7 @@ journey('DataViewPermissions', async ({ page, params }) => { await page.goto(`${baseUrl}?${queryParams}`, { waitUntil: 'networkidle', }); - await login.loginToKibana('viewer_user', 'changeme'); + await login.loginToKibana('viewer', 'changeme'); }); step('Click explore data button', async () => { diff --git a/x-pack/plugins/synthetics/e2e/journeys/monitor_management_enablement.journey.ts b/x-pack/plugins/synthetics/e2e/journeys/monitor_management_enablement.journey.ts index b7308ece8af21..5d22fe8491579 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/monitor_management_enablement.journey.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/monitor_management_enablement.journey.ts @@ -57,7 +57,7 @@ journey( }); step('login to Kibana', async () => { - await uptime.loginToKibana('editor_user', 'changeme'); + await uptime.loginToKibana('editor', 'changeme'); const invalid = await page.locator( `text=Username or password is incorrect. Please try again.` ); diff --git a/x-pack/plugins/synthetics/e2e/journeys/read_only_user/monitor_management.ts b/x-pack/plugins/synthetics/e2e/journeys/read_only_user/monitor_management.ts index 33698961951da..677983ca9260b 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/read_only_user/monitor_management.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/read_only_user/monitor_management.ts @@ -23,7 +23,7 @@ journey( }); step('login to Kibana', async () => { - await uptime.loginToKibana('viewer_user', 'changeme'); + await uptime.loginToKibana('viewer', 'changeme'); }); step('Adding monitor is disabled', async () => { diff --git a/x-pack/plugins/synthetics/e2e/page_objects/login.tsx b/x-pack/plugins/synthetics/e2e/page_objects/login.tsx index ae52bb45ddb84..ee0fe0f596b98 100644 --- a/x-pack/plugins/synthetics/e2e/page_objects/login.tsx +++ b/x-pack/plugins/synthetics/e2e/page_objects/login.tsx @@ -24,7 +24,7 @@ export function loginPageProvider({ await page.waitForTimeout(5 * 1000); } }, - async loginToKibana(usernameT?: string, passwordT?: string) { + async loginToKibana(usernameT?: 'editor' | 'viewer', passwordT?: string) { if (isRemote) { await page.click('text="Log in with Elasticsearch"'); } diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/hooks/use_status_by_location.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/hooks/use_status_by_location.tsx new file mode 100644 index 0000000000000..d3da5bc1b35ee --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/hooks/use_status_by_location.tsx @@ -0,0 +1,74 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEsSearch } from '@kbn/observability-plugin/public'; +import { useParams } from 'react-router-dom'; +import { useMemo } from 'react'; +import { Ping } from '../../../../../../common/runtime_types'; +import { + EXCLUDE_RUN_ONCE_FILTER, + getTimeSpanFilter, + SUMMARY_FILTER, +} from '../../../../../../common/constants/client_defaults'; +import { useSyntheticsRefreshContext } from '../../../contexts/synthetics_refresh_context'; +import { SYNTHETICS_INDEX_PATTERN, UNNAMED_LOCATION } from '../../../../../../common/constants'; + +export function useStatusByLocation() { + const { lastRefresh } = useSyntheticsRefreshContext(); + + const { monitorId } = useParams<{ monitorId: string }>(); + + const { data, loading } = useEsSearch( + { + index: SYNTHETICS_INDEX_PATTERN, + body: { + size: 0, + query: { + bool: { + filter: [ + SUMMARY_FILTER, + EXCLUDE_RUN_ONCE_FILTER, + getTimeSpanFilter(), + { + term: { + config_id: monitorId, + }, + }, + ], + }, + }, + sort: [{ '@timestamp': 'desc' }], + aggs: { + locations: { + terms: { + field: 'observer.geo.name', + missing: UNNAMED_LOCATION, + size: 1000, + }, + aggs: { + summary: { + top_hits: { + size: 1, + }, + }, + }, + }, + }, + }, + }, + [lastRefresh, monitorId], + { name: 'getMonitorStatusByLocation' } + ); + + return useMemo(() => { + const locations = (data?.aggregations?.locations.buckets ?? []).map((loc) => { + return loc.summary.hits.hits?.[0]._source as Ping; + }); + + return { locations, loading }; + }, [data, loading]); +} diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary.tsx index 9ac2d67967eeb..de5871304eccf 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary.tsx @@ -5,14 +5,23 @@ * 2.0. */ -import React from 'react'; -import { useSelector } from 'react-redux'; -import { selectMonitorStatus } from '../../state/monitor_summary'; +import React, { useEffect } from 'react'; +import { useSelector, useDispatch } from 'react-redux'; +import { useParams } from 'react-router-dom'; +import { getSyntheticsMonitorAction, selectMonitorStatus } from '../../state/monitor_summary'; import { useMonitorListBreadcrumbs } from '../monitors_page/hooks/use_breadcrumbs'; export const MonitorSummaryPage = () => { const { data } = useSelector(selectMonitorStatus); useMonitorListBreadcrumbs([{ text: data?.monitor.name ?? '' }]); + const dispatch = useDispatch(); + + const { monitorId } = useParams<{ monitorId: string }>(); + + useEffect(() => { + dispatch(getSyntheticsMonitorAction.get(monitorId)); + }, [dispatch, monitorId]); + return <>; }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary_tabs.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary_tabs.tsx index 3469341d86ca6..725d209c8200e 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary_tabs.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/monitor_summary_tabs.tsx @@ -50,7 +50,7 @@ export const MonitorSummaryTabs = () => { return ( {}} /> diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/locations_status.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/locations_status.tsx new file mode 100644 index 0000000000000..6c918c1288366 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/locations_status.tsx @@ -0,0 +1,32 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; +import { EuiBadge, EuiBadgeGroup, EuiIcon, EuiLoadingSpinner } from '@elastic/eui'; +import { useStatusByLocation } from '../hooks/use_status_by_location'; + +export const LocationsStatus = () => { + const { locations, loading } = useStatusByLocation(); + + if (loading) { + return ; + } + + return ( + + {locations.map((loc) => ( + ( + 0 ? 'danger' : 'success'} /> + )} + color="hollow" + > + {loc.observer?.geo?.name} + + ))} + + ); +}; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_details_panel.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_details_panel.tsx new file mode 100644 index 0000000000000..8ed2c5dffd771 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_details_panel.tsx @@ -0,0 +1,111 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { + EuiDescriptionList, + EuiDescriptionListTitle, + EuiDescriptionListDescription, + EuiBadge, + EuiSpacer, + EuiLink, + EuiLoadingSpinner, +} from '@elastic/eui'; +import { capitalize } from 'lodash'; +import { i18n } from '@kbn/i18n'; +import { useDispatch, useSelector } from 'react-redux'; +import { useParams } from 'react-router-dom'; +import { MonitorTags } from './monitor_tags'; +import { MonitorEnabled } from '../../monitors_page/management/monitor_list_table/monitor_enabled'; +import { LocationsStatus } from './locations_status'; +import { + getSyntheticsMonitorAction, + selectMonitorStatus, + syntheticsMonitorSelector, +} from '../../../state/monitor_summary'; +import { ConfigKey } from '../../../../../../common/runtime_types'; + +export const MonitorDetailsPanel = () => { + const { data } = useSelector(selectMonitorStatus); + + const { monitorId } = useParams<{ monitorId: string }>(); + + const dispatch = useDispatch(); + + const { data: monitor, loading } = useSelector(syntheticsMonitorSelector); + + if (!data) { + return ; + } + + return ( + <> + + + {ENABLED_LABEL} + + {monitor && ( + { + dispatch(getSyntheticsMonitorAction.get(monitorId)); + }} + /> + )} + + {MONITOR_TYPE_LABEL} + + {capitalize(data.monitor.type)} + + {FREQUENCY_LABEL} + Every 10 mins + {LOCATIONS_LABEL} + + + + {URL_LABEL} + + + {data.url?.full} + + + {TAGS_LABEL} + + {monitor && } + + + + ); +}; + +const FREQUENCY_LABEL = i18n.translate('xpack.synthetics.management.monitorList.frequency', { + defaultMessage: 'Frequency', +}); +const LOCATIONS_LABEL = i18n.translate('xpack.synthetics.management.monitorList.locations', { + defaultMessage: 'Locations', +}); + +const URL_LABEL = i18n.translate('xpack.synthetics.management.monitorList.url', { + defaultMessage: 'URL', +}); + +const TAGS_LABEL = i18n.translate('xpack.synthetics.management.monitorList.tags', { + defaultMessage: 'Tags', +}); + +const ENABLED_LABEL = i18n.translate('xpack.synthetics.detailsPanel.monitorDetails.enabled', { + defaultMessage: 'Enabled', +}); + +const MONITOR_TYPE_LABEL = i18n.translate( + 'xpack.synthetics.detailsPanel.monitorDetails.monitorType', + { + defaultMessage: 'Monitor type', + } +); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_tags.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_tags.tsx new file mode 100644 index 0000000000000..7960d5efbc1e7 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/monitor_tags.tsx @@ -0,0 +1,19 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiBadge, EuiBadgeGroup } from '@elastic/eui'; + +export const MonitorTags = ({ tags }: { tags: string[] }) => { + return ( + + {tags.map((tag) => ( + {tag} + ))} + + ); +}; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/summary_tab_content.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/summary_tab_content.tsx index e426ebbf2e309..c0a2f2c3b30d8 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/summary_tab_content.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_summary/tabs_content/summary_tab_content.tsx @@ -5,9 +5,23 @@ * 2.0. */ -import { EuiText } from '@elastic/eui'; import React from 'react'; +import { EuiTitle, EuiPanel } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { MonitorDetailsPanel } from './monitor_details_panel'; export const SummaryTabContent = () => { - return Monitor summary tab content; + return ( + + +

{MONITOR_DETAILS_LABEL}

+ + + + ); }; + +const MONITOR_DETAILS_LABEL = i18n.translate('xpack.synthetics.detailsPanel.monitorDetails', { + defaultMessage: 'Monitor details', +}); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/columns.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/columns.tsx index 5665c402442ab..d3803a0aa0260 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/columns.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/columns.tsx @@ -132,12 +132,7 @@ export function getMonitorListColumns({ defaultMessage: 'Enabled', }), render: (_enabled: boolean, monitor: EncryptedSyntheticsSavedMonitor) => ( - + ), }, { diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/monitor_enabled.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/monitor_enabled.tsx index e98ca2a466f0d..36527f3316935 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/monitor_enabled.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/monitor_list_table/monitor_enabled.tsx @@ -10,6 +10,7 @@ import React, { useEffect, useState } from 'react'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { FETCH_STATUS, useFetcher } from '@kbn/observability-plugin/public'; +import { useCanEditSynthetics } from '../../../../../../hooks/use_capabilities'; import { ConfigKey, EncryptedSyntheticsMonitor } from '../../../../../../../common/runtime_types'; import { fetchUpsertMonitor } from '../../../../state'; @@ -19,10 +20,12 @@ interface Props { id: string; monitor: EncryptedSyntheticsMonitor; reloadPage: () => void; - isDisabled?: boolean; + initialLoading?: boolean; } -export const MonitorEnabled = ({ id, monitor, reloadPage, isDisabled }: Props) => { +export const MonitorEnabled = ({ id, monitor, reloadPage, initialLoading }: Props) => { + const isDisabled = !useCanEditSynthetics(); + const [isEnabled, setIsEnabled] = useState(null); const { notifications } = useKibana(); @@ -69,7 +72,7 @@ export const MonitorEnabled = ({ id, monitor, reloadPage, isDisabled }: Props) = return ( <> - {isLoading ? ( + {isLoading || initialLoading ? ( ) : ( ( ); export const getMonitorStatusAction = createAsyncAction('[MONITOR SUMMARY] GET'); + +export const getSyntheticsMonitorAction = createAsyncAction( + 'fetchSyntheticsMonitorAction' +); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/api.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/api.ts index 0d0a6c628f03a..af01acf97592d 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/api.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/api.ts @@ -5,9 +5,10 @@ * 2.0. */ +import { SavedObject } from '@kbn/core/types'; import { apiService } from '../../../../utils/api_service'; -import { Ping } from '../../../../../common/runtime_types'; -import { SYNTHETICS_API_URLS } from '../../../../../common/constants'; +import { Ping, SyntheticsMonitor } from '../../../../../common/runtime_types'; +import { API_URLS, SYNTHETICS_API_URLS } from '../../../../../common/constants'; export interface QueryParams { monitorId: string; @@ -18,3 +19,11 @@ export interface QueryParams { export const fetchMonitorStatus = async (params: QueryParams): Promise => { return await apiService.get(SYNTHETICS_API_URLS.MONITOR_STATUS, { ...params }); }; + +export const fetchSyntheticsMonitor = async (monitorId: string): Promise => { + const { attributes } = (await apiService.get( + `${API_URLS.SYNTHETICS_MONITORS}/${monitorId}` + )) as SavedObject; + + return attributes; +}; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/effects.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/effects.ts index dae9f72ac804e..9a1b52e1e24df 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/effects.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/effects.ts @@ -7,8 +7,8 @@ import { takeLeading } from 'redux-saga/effects'; import { fetchEffectFactory } from '../utils/fetch_effect'; -import { getMonitorStatusAction } from './actions'; -import { fetchMonitorStatus } from './api'; +import { getMonitorStatusAction, getSyntheticsMonitorAction } from './actions'; +import { fetchMonitorStatus, fetchSyntheticsMonitor } from './api'; export function* fetchMonitorStatusEffect() { yield takeLeading( @@ -20,3 +20,14 @@ export function* fetchMonitorStatusEffect() { ) ); } + +export function* fetchSyntheticsMonitorEffect() { + yield takeLeading( + getSyntheticsMonitorAction.get, + fetchEffectFactory( + fetchSyntheticsMonitor, + getSyntheticsMonitorAction.success, + getSyntheticsMonitorAction.fail + ) + ); +} diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/selectors.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/selectors.ts index 09a89a1f07619..d361024e839f2 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/selectors.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/selectors.ts @@ -16,3 +16,5 @@ export const selectSelectedLocationId = createSelector( ); export const selectMonitorStatus = createSelector(getState, (state) => state); + +export const syntheticsMonitorSelector = (state: SyntheticsAppState) => state.syntheticsMonitor; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/synthetics_montior_reducer.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/synthetics_montior_reducer.ts new file mode 100644 index 0000000000000..e1049c3b862d3 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_summary/synthetics_montior_reducer.ts @@ -0,0 +1,38 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { IHttpFetchError, ResponseErrorBody } from '@kbn/core/public'; +import { createReducer } from '@reduxjs/toolkit'; +import { SyntheticsMonitor } from '../../../../../common/runtime_types'; +import { getSyntheticsMonitorAction } from './actions'; + +export interface SyntheticsMonitorState { + data: SyntheticsMonitor | null; + loading: boolean; + error: IHttpFetchError | null; +} + +const initialState: SyntheticsMonitorState = { + data: null, + loading: false, + error: null, +}; + +export const syntheticsMonitorReducer = createReducer(initialState, (builder) => { + builder + .addCase(getSyntheticsMonitorAction.get, (state) => { + state.loading = true; + }) + .addCase(getSyntheticsMonitorAction.success, (state, action) => { + state.data = action.payload; + state.loading = false; + }) + .addCase(getSyntheticsMonitorAction.fail, (state, action) => { + state.error = action.payload as IHttpFetchError; + state.loading = false; + }); +}); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/root_effect.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/root_effect.ts index 9cae9249af971..45214cf4d2461 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/root_effect.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/root_effect.ts @@ -6,7 +6,7 @@ */ import { all, fork } from 'redux-saga/effects'; -import { fetchMonitorStatusEffect } from './monitor_summary'; +import { fetchMonitorStatusEffect, fetchSyntheticsMonitorEffect } from './monitor_summary'; import { fetchIndexStatusEffect } from './index_status'; import { fetchSyntheticsEnablementEffect } from './synthetics_enablement'; import { fetchMonitorListEffect } from './monitor_list'; @@ -19,5 +19,6 @@ export const rootEffect = function* root(): Generator { fork(fetchServiceLocationsEffect), fork(fetchMonitorListEffect), fork(fetchMonitorStatusEffect), + fork(fetchSyntheticsMonitorEffect), ]); }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/root_reducer.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/root_reducer.ts index 4ecd0dbc265ab..bd4b25b456e93 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/root_reducer.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/root_reducer.ts @@ -7,6 +7,7 @@ import { combineReducers } from '@reduxjs/toolkit'; +import { syntheticsMonitorReducer } from './monitor_summary/synthetics_montior_reducer'; import { monitorStatusReducer } from './monitor_summary'; import { uiReducer } from './ui'; import { indexStatusReducer } from './index_status'; @@ -21,6 +22,7 @@ export const rootReducer = combineReducers({ monitorList: monitorListReducer, serviceLocations: serviceLocationsReducer, monitorStatus: monitorStatusReducer, + syntheticsMonitor: syntheticsMonitorReducer, }); export type SyntheticsAppState = ReturnType; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/syncthetics_store.mock.ts b/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/syncthetics_store.mock.ts index c5aad9ffa01ac..3a9c13f928a76 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/syncthetics_store.mock.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/syncthetics_store.mock.ts @@ -84,4 +84,9 @@ export const mockState: SyntheticsAppState = { error: null, selectedLocationId: null, }, + syntheticsMonitor: { + data: null, + loading: false, + error: null, + }, }; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap index ef5bb793abef3..84a00b4a859d8 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap @@ -22,7 +22,7 @@ exports[`UptimePageTemplateComponent styling applies the header centering on mob class="euiPageBody euiPageBody--borderRadiusNone" >
OK
-
- for 4 months -
+ for 4 months
diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx index 91c34a270b562..25ed39569bc8b 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx @@ -9,7 +9,7 @@ import React, { memo, useMemo, useCallback } from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiFormRow } from '@elastic/eui'; import { Validation } from '../types'; -import { ConfigKey } from '../types'; +import { ConfigKey, MonitorFields } from '../types'; import { useBrowserSimpleFieldsContext } from '../contexts'; import { ScheduleField } from '../schedule_field'; import { SourceField } from './source_field'; @@ -76,7 +76,7 @@ export const BrowserSimpleFields = memo(({ validate, onFieldBlur }) => { defaultMessage="Frequency" /> } - isInvalid={!!validate[ConfigKey.SCHEDULE]?.(fields)} + isInvalid={!!validate[ConfigKey.SCHEDULE]?.(fields as Partial)} error={ { it('handles browser data stream', async () => { const onChange = jest.fn(); const initialProps = { - defaultConfig: defaultConfig[DataStream.BROWSER], - config: defaultConfig[DataStream.BROWSER], + defaultConfig: defaultConfig[DataStream.BROWSER] as Partial, + config: defaultConfig[DataStream.BROWSER] as Partial, newPolicy, onChange, validate, @@ -637,7 +638,7 @@ describe('useBarChartsHooks', () => { rerender({ ...initialProps, - config, + config: config as Partial, }); await waitFor(() => { diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx index 6247619f6a3b6..d84420f155798 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx @@ -8,8 +8,7 @@ import React, { memo, useEffect, useMemo } from 'react'; import { PackagePolicyCreateExtensionComponentProps } from '@kbn/fleet-plugin/public'; import { useTrackPageview } from '@kbn/observability-plugin/public'; -import { DataStream } from './types'; -import { PolicyConfig } from './types'; +import { DataStream, PolicyConfig, MonitorFields } from './types'; import { usePolicyConfigContext } from './contexts'; import { DEFAULT_FIELDS } from '../../../../common/constants/monitor_defaults'; import { CustomFields } from './custom_fields'; @@ -39,8 +38,8 @@ export const SyntheticsPolicyCreateExtension = memo, + config: policyConfig[monitorType] as Partial, newPolicy, onChange, validate, diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx index edc8e3f58d490..771ac6ed8c88f 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx @@ -35,7 +35,7 @@ export const SyntheticsPolicyEditExtension = memo, newPolicy, onChange, validate, diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts index b2cca04b44d1b..2a9ead81fce33 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts @@ -9,9 +9,9 @@ import { ConfigKey, DataStream, HTTPFields, - BrowserFields, MonitorFields, ScheduleUnit, + SyntheticsMonitor, } from '../../../../common/runtime_types'; import { validate } from './validation'; @@ -53,18 +53,20 @@ describe('[Monitor Management] validation', () => { [ConfigKey.SOURCE_INLINE, 'step(() => {});'], [ConfigKey.SOURCE_ZIP_URL, 'https://test.zip'], ])('Browser', (configKey, value) => { - const browserProps: Partial = { + const browserProps = { ...commonPropsValid, [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, [ConfigKey.TIMEOUT]: null, + [ConfigKey.URLS]: null, + [ConfigKey.PORT]: null, [configKey]: value, - }; + } as SyntheticsMonitor; it('should return false for all valid props', () => { const validators = validate[DataStream.BROWSER]; const keysToValidate = [ConfigKey.SCHEDULE, ConfigKey.TIMEOUT, configKey]; const validatorFns = keysToValidate.map((key) => validators[key]); - const result = validatorFns.map((fn) => fn?.(browserProps) ?? true); + const result = validatorFns.map((fn) => fn?.(browserProps as Partial) ?? true); expect(result).not.toEqual(expect.arrayContaining([true])); }); diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap index b8067ae79c3fe..e5fe132885602 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap @@ -140,61 +140,57 @@ exports[`PingListExpandedRow renders link to docs if body is not recorded but it class="euiFlexItem" >
-
-
-
+
+
- Response Body - -
+
+
-
- Body size is 1MB. -
-
-
- Body not recorded. Read our - + External link + + - docs - - External link - - - (opens in a new tab or window) - - - for more information on recording response bodies. -
-
-
-
+ (opens in a new tab or window) + + + for more information on recording response bodies. +
+ +
diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap index 3899c27acf1d7..3ddab9f8bd10a 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap @@ -5,8 +5,7 @@ exports[`Ping Headers shallow renders expected elements for valid props 1`] = ` - } - buttonElement="button" - element="div" id="responseHeaderAccord" - initialIsOpen={false} - isLoading={false} - isLoadingMessage={false} - paddingSize="none" > - + `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap index afe3bacea17fb..f61aaa763b106 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap @@ -37,7 +37,7 @@ Array [ class="euiToolTipAnchor" >
props.theme.eui.paddingSizes.m}; + margin-right: ${(props) => props.theme.eui.euiSizeM}; max-width: 7%; min-width: 160px; `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts index ae4792d8af883..1046f48c1bd70 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts @@ -113,7 +113,7 @@ export const WaterfallChartSidebarContainerFlexGroup = euiStyled(EuiFlexGroup)` // Ensures flex items honour no-wrap of children, rather than trying to extend to the full width of children. export const WaterfallChartSidebarFlexItem = euiStyled(EuiFlexItem)` min-width: 0; - padding-right: ${(props) => props.theme.eui.paddingSizes.s}; + padding-right: ${(props) => props.theme.eui.euiSizeS}; justify-content: space-around; `; @@ -143,7 +143,7 @@ export const WaterfallChartLegendContainer = euiStyled.div` bottom: 0; z-index: ${(props) => props.theme.eui.euiZLevel4}; background-color: ${(props) => props.theme.eui.euiColorLightestShade}; - padding: ${(props) => props.theme.eui.paddingSizes.xs}; + padding: ${(props) => props.theme.eui.euiSizeXS}; font-size: ${(props) => props.theme.eui.euiFontSizeXS}; box-shadow: 0px -1px 4px 0px ${(props) => props.theme.eui.euiColorLightShade}; `; // NOTE: EuiShadowColor is a little too dark to work with the background-color @@ -157,7 +157,7 @@ export const WaterfallChartTooltip = euiStyled(WaterfallTooltipResponsiveMaxWidt background-color: ${(props) => props.theme.eui.euiColorDarkestShade}; border-radius: ${(props) => props.theme.eui.euiBorderRadius}; color: ${(props) => props.theme.eui.euiColorLightestShade}; - padding: ${(props) => props.theme.eui.paddingSizes.s}; + padding: ${(props) => props.theme.eui.euiSizeS}; .euiToolTip__arrow { background-color: ${(props) => props.theme.eui.euiColorDarkestShade}; } @@ -165,7 +165,7 @@ export const WaterfallChartTooltip = euiStyled(WaterfallTooltipResponsiveMaxWidt export const NetworkRequestsTotalStyle = euiStyled(EuiText)` line-height: 28px; - padding: 0 ${(props) => props.theme.eui.paddingSizes.m}; + padding: 0 ${(props) => props.theme.eui.euiSizeM}; border-bottom: 0.3px solid ${(props) => props.theme.eui.euiColorLightShade}; z-index: ${(props) => props.theme.eui.euiZLevel5}; `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx index 3e85c932bf700..7c430963e03d1 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx @@ -41,8 +41,8 @@ export const MonitorConfig = ({ isEdit = false }: { isEdit: boolean }) => { const { isValid, config } = useFormatMonitor({ monitorType, validate, - config: policyConfig[monitorType], - defaultConfig: DEFAULT_FIELDS[monitorType], + config: policyConfig[monitorType] as Partial, + defaultConfig: DEFAULT_FIELDS[monitorType] as Partial, }); const [hasBeenSubmitted, setHasBeenSubmitted] = useState(false); diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts index ce7c08a45dbaf..dc2e5cb48c077 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts @@ -9,10 +9,10 @@ import { ConfigKey, DataStream, HTTPFields, - BrowserFields, MonitorFields, ScheduleUnit, ServiceLocations, + SyntheticsMonitor, } from '../../../../common/runtime_types'; import { validate, validateCommon } from './validation'; @@ -96,18 +96,18 @@ describe('[Monitor Management] validation', () => { [ConfigKey.SOURCE_INLINE, 'step(() => {});'], [ConfigKey.SOURCE_ZIP_URL, 'https://test.zip'], ])('Browser', (configKey, value) => { - const browserProps: Partial = { + const browserProps = { ...commonPropsValid, [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, [ConfigKey.TIMEOUT]: undefined, [configKey]: value, - }; + } as SyntheticsMonitor; it('should return false for all valid props', () => { const validators = validate[DataStream.BROWSER]; const keysToValidate = [ConfigKey.SCHEDULE, ConfigKey.TIMEOUT, configKey]; const validatorFns = keysToValidate.map((key) => validators[key]); - const result = validatorFns.map((fn) => fn?.(browserProps) ?? true); + const result = validatorFns.map((fn) => fn?.(browserProps as Partial) ?? true); expect(result).not.toEqual(expect.arrayContaining([true])); }); diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx index a1c6b88042b77..3af35148501c0 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx @@ -93,7 +93,7 @@ const getSeverityOptions = () => -

+

matching monitors are down > 5 times diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap index 5ff6e5773485b..9137fa97dbb89 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap @@ -16,17 +16,17 @@ exports[`TimeExpressionSelect component should renders against props 1`] = ` > within last 15 @@ -46,15 +46,15 @@ exports[`TimeExpressionSelect component should renders against props 1`] = ` > minutes diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx index 7f64c1199c2b0..a6305ccc654ba 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx @@ -284,5 +284,5 @@ const getCheckedLabel = (timestamp: Moment) => { }; const PaddedText = euiStyled(EuiText)` - padding-right: ${(props) => props.theme.eui.paddingSizes.xs}; + padding-right: ${(props) => props.theme.eui.euiSizeXS}; `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.test.tsx new file mode 100644 index 0000000000000..0aabe45d140bd --- /dev/null +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.test.tsx @@ -0,0 +1,36 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { renderHook } from '@testing-library/react-hooks'; +import { useMonitorHistogram } from './use_monitor_histogram'; +import { WrappedHelper } from '../../../../apps/synthetics/utils/testing'; +import * as searchHooks from '@kbn/observability-plugin/public/hooks/use_es_search'; +import * as reduxHooks from 'react-redux'; + +describe('useMonitorHistogram', () => { + const dynamicIndexPattern = 'synthetics-*'; + const useEsSearch = jest.fn().mockReturnValue({}); + jest + .spyOn(reduxHooks, 'useSelector') + .mockReturnValue({ settings: { heartbeatIndices: dynamicIndexPattern } }); + jest.spyOn(searchHooks, 'useEsSearch').mockImplementation(useEsSearch); + + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('calls dynamic heartbeat index', () => { + renderHook(() => useMonitorHistogram({ items: [] }), { + wrapper: WrappedHelper, + }); + expect(useEsSearch).toBeCalledWith( + expect.objectContaining({ index: dynamicIndexPattern }), + ['[]', 0], + { name: 'getMonitorDownHistory' } + ); + }); +}); diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts index 1a9b7b73732af..e0c6a6cbcfa00 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts @@ -16,25 +16,24 @@ import { } from '../../../../../common/runtime_types/monitor'; import { useGetUrlParams } from '../../../hooks'; import { UptimeRefreshContext } from '../../../contexts'; -import { esKuerySelector } from '../../../state/selectors'; +import { selectDynamicSettings } from '../../../state/selectors'; import { getHistogramInterval } from '../../../../../common/lib/get_histogram_interval'; import { Ping } from '../../../../../common/runtime_types'; export const useMonitorHistogram = ({ items }: { items: MonitorSummary[] }) => { - const { dateRangeStart, dateRangeEnd, statusFilter } = useGetUrlParams(); + const { dateRangeStart, dateRangeEnd } = useGetUrlParams(); const { lastRefresh } = useContext(UptimeRefreshContext); - const filters = useSelector(esKuerySelector); + const { settings } = useSelector(selectDynamicSettings); const monitorIds = (items ?? []).map(({ monitor_id: monitorId }) => monitorId); const { queryParams, minInterval } = getQueryParams( dateRangeStart, dateRangeEnd, - filters, - statusFilter, - monitorIds + monitorIds, + settings?.heartbeatIndices || '' ); const { data, loading } = useEsSearch( @@ -77,14 +76,13 @@ export const useMonitorHistogram = ({ items }: { items: MonitorSummary[] }) => { const getQueryParams = ( dateRangeStart: string, dateRangeEnd: string, - filters: string, - statusFilter: string, - monitorIds: string[] + monitorIds: string[], + index: string ) => { const minInterval = getHistogramInterval(dateRangeStart, dateRangeEnd, 12); const queryParams = { - index: 'heartbeat-*', + index, body: { size: 0, query: { diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx index 2ef6c7718f7bc..64ab69e0aa39f 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx @@ -12,7 +12,7 @@ import { ReactRouterEuiLink } from '../../../common/react_router_helpers'; import { Ping } from '../../../../../../common/runtime_types/ping/ping'; const LabelLink = euiStyled.div` - margin-bottom: ${(props) => props.theme.eui.paddingSizes.xs}; + margin-bottom: ${(props) => props.theme.eui.euiSizeXS}; font-size: ${({ theme }) => theme.eui.euiFontSizeS}; `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx index d0db4a99a495e..19cda36754c66 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx @@ -19,7 +19,7 @@ import { ScreenshotLink } from './screenshot_link'; import { getShortTimeStamp } from '../../../overview/monitor_list/columns/monitor_status_column'; const Label = euiStyled.div` - margin-bottom: ${(props) => props.theme.eui.paddingSizes.xs}; + margin-bottom: ${(props) => props.theme.eui.euiSizeXS}; font-size: ${({ theme }) => theme.eui.euiFontSizeS}; color: ${({ theme }) => theme.eui.euiColorDarkShade}; `; diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx index 063dd9db0eae3..80c09b44bcedb 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx @@ -23,7 +23,7 @@ interface ExecutedStepProps { } const Label = euiStyled.div` - margin-bottom: ${(props) => props.theme.eui.paddingSizes.xs}; + margin-bottom: ${(props) => props.theme.eui.euiSizeXS}; font-size: ${({ theme }) => theme.eui.euiFontSizeS}; color: ${({ theme }) => theme.eui.euiColorDarkShade}; `; @@ -31,7 +31,7 @@ const Label = euiStyled.div` const Message = euiStyled.div` font-weight: bold; font-size:${({ theme }) => theme.eui.euiFontSizeM}; - margin-bottom: ${(props) => props.theme.eui.paddingSizes.m}; + margin-bottom: ${(props) => props.theme.eui.euiSizeM}; `; const ExpandedRow = euiStyled.div` diff --git a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts index e862bec6e92cc..e22aef73e19d6 100644 --- a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts +++ b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts @@ -173,8 +173,8 @@ describe('validateMonitor', () => { [ConfigKey.SOURCE_ZIP_PASSWORD]: 'password', [ConfigKey.SOURCE_ZIP_PROXY_URL]: 'http://proxy-url.com', [ConfigKey.PARAMS]: '', - [ConfigKey.URLS]: undefined, - [ConfigKey.PORT]: undefined, + [ConfigKey.URLS]: null, + [ConfigKey.PORT]: null, }; testBrowserAdvancedFields = { @@ -309,7 +309,7 @@ describe('validateMonitor', () => { const testMonitor = { ...testHTTPFields, ...({ - [ConfigKey.URLS]: undefined, + [ConfigKey.URLS]: null, } as unknown as Partial), } as MonitorFields; diff --git a/x-pack/plugins/synthetics/server/synthetics_service/hydrate_saved_object.ts b/x-pack/plugins/synthetics/server/synthetics_service/hydrate_saved_object.ts index 92f457d3c0516..a2ea7a906fb7b 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/hydrate_saved_object.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/hydrate_saved_object.ts @@ -70,7 +70,7 @@ export const hydrateSavedObjects = async ({ monitors .filter((monitor) => missingInfoIds.includes(monitor.id)) .forEach((monitor) => { - let resultAttributes: Partial = monitor.attributes; + let resultAttributes: SyntheticsMonitor = monitor.attributes; let isUpdated = false; diff --git a/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts b/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts index 02d0f69ddbedc..235055b8c2b38 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/service_api_client.ts @@ -55,8 +55,11 @@ export class ServiceAPIClient { this.server = server; } - getHttpsAgent() { + getHttpsAgent(url: string) { const config = this.config; + if (url !== this.config.devUrl && this.authorization && this.server.isDev) { + return; + } if (config.tls && config.tls.certificate && config.tls.key) { const tlsConfig = new SslConfig(config.tls); @@ -92,29 +95,31 @@ export class ServiceAPIClient { return { allowed: true, signupUrl: null }; } - const httpsAgent = this.getHttpsAgent(); - - if (this.locations.length > 0 && httpsAgent) { + if (this.locations.length > 0) { // get a url from a random location const url = this.locations[Math.floor(Math.random() * this.locations.length)].url; - try { - const { data } = await axios({ - method: 'GET', - url: url + '/allowed', - headers: - process.env.NODE_ENV !== 'production' && this.authorization - ? { - Authorization: this.authorization, - } - : undefined, - httpsAgent, - }); - - const { allowed, signupUrl } = data; - return { allowed, signupUrl }; - } catch (e) { - this.logger.error(e); + const httpsAgent = this.getHttpsAgent(url); + + if (httpsAgent) { + try { + const { data } = await axios({ + method: 'GET', + url: url + '/allowed', + headers: + process.env.NODE_ENV !== 'production' && this.authorization + ? { + Authorization: this.authorization, + } + : undefined, + httpsAgent, + }); + + const { allowed, signupUrl } = data; + return { allowed, signupUrl }; + } catch (e) { + this.logger.error(e); + } } } @@ -151,7 +156,7 @@ export class ServiceAPIClient { Authorization: this.authorization, } : undefined, - httpsAgent: this.getHttpsAgent(), + httpsAgent: this.getHttpsAgent(url), }); }; diff --git a/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts b/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts index 8103415af9492..1e353f4301f45 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/synthetics_service.ts @@ -439,8 +439,8 @@ export class SyntheticsService { } formatConfigs(configs: SyntheticsMonitorWithId[]) { - return configs.map((config: Partial) => - formatMonitorConfig(Object.keys(config) as ConfigKey[], config) + return configs.map((config: SyntheticsMonitor) => + formatMonitorConfig(Object.keys(config) as ConfigKey[], config as Partial) ); } diff --git a/x-pack/plugins/timelines/common/types/timeline/index.ts b/x-pack/plugins/timelines/common/types/timeline/index.ts index a19086f583284..8737652b47f4d 100644 --- a/x-pack/plugins/timelines/common/types/timeline/index.ts +++ b/x-pack/plugins/timelines/common/types/timeline/index.ts @@ -323,6 +323,7 @@ export enum TimelineId { test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', rulePreview = 'rule-preview', + kubernetesPageSessions = 'kubernetes-page-sessions', } export const TimelineIdLiteralRt = runtimeTypes.union([ @@ -335,6 +336,7 @@ export const TimelineIdLiteralRt = runtimeTypes.union([ runtimeTypes.literal(TimelineId.active), runtimeTypes.literal(TimelineId.test), runtimeTypes.literal(TimelineId.rulePreview), + runtimeTypes.literal(TimelineId.kubernetesPageSessions), ]); export type TimelineIdLiteral = runtimeTypes.TypeOf; diff --git a/x-pack/plugins/timelines/public/components/t_grid/event_rendered_view/index.tsx b/x-pack/plugins/timelines/public/components/t_grid/event_rendered_view/index.tsx index 4e7138aae6cbf..2311ea3192c9a 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/event_rendered_view/index.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/event_rendered_view/index.tsx @@ -41,7 +41,7 @@ const ActionsContainer = styled.div` display: flex; align-items: center; div div:first-child div.siemEventsTable__tdContent { - margin-left: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-left: ${({ theme }) => theme.eui.euiSizeM}; } `; @@ -49,7 +49,7 @@ const ActionsContainer = styled.div` type BasicTableType = ComponentType>; const StyledEuiBasicTable = styled(EuiBasicTable as BasicTableType)` - padding-top: ${({ theme }) => theme.eui.paddingSizes.m}; + padding-top: ${({ theme }) => theme.eui.euiSizeM}; .EventRenderedView__buildingBlock { background: ${({ theme }) => theme.eui.euiColorHighlight}; } diff --git a/x-pack/plugins/timelines/public/components/t_grid/integrated/index.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/integrated/index.test.tsx index 9caa239e5e602..15fd4d2ce75cf 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/integrated/index.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/integrated/index.test.tsx @@ -75,7 +75,7 @@ describe('integrated t_grid', () => { expect(screen.queryByTestId('updated-flex-group')).toHaveStyleRule( `margin-right`, - euiDarkVars.paddingSizes.xl + euiDarkVars.euiSizeXL ); }); it(`does not render the empty state when the graph overlay is open`, () => { diff --git a/x-pack/plugins/timelines/public/components/t_grid/styles.tsx b/x-pack/plugins/timelines/public/components/t_grid/styles.tsx index 7f4767e45fec7..cfd87c1c6ba5b 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/styles.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/styles.tsx @@ -185,7 +185,7 @@ export const EventsThContent = styled.div.attrs(({ className = '' }) => ({ font-weight: ${({ theme }) => theme.eui.euiFontWeightSemiBold}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; min-width: 0; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; text-align: ${({ textAlign }) => textAlign}; width: ${({ width }) => width != null @@ -194,7 +194,7 @@ export const EventsThContent = styled.div.attrs(({ className = '' }) => ({ > button.euiButtonIcon, > .euiToolTipAnchor > button.euiButtonIcon { - margin-left: ${({ theme }) => `-${theme.eui.paddingSizes.xs}`}; + margin-left: ${({ theme }) => `-${theme.eui.euiSizeXS}`}; } `; @@ -286,12 +286,12 @@ export const EventsTrSupplement = styled.div.attrs(({ className = '' }) => ({ }))<{ className: string }>` font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; - padding-left: ${({ theme }) => theme.eui.paddingSizes.m}; + padding-left: ${({ theme }) => theme.eui.euiSizeM}; .euiAccordion + div { background-color: ${({ theme }) => theme.eui.euiColorEmptyShade}; - padding: 0 ${({ theme }) => theme.eui.paddingSizes.s}; + padding: 0 ${({ theme }) => theme.eui.euiSizeS}; border: 1px solid ${({ theme }) => theme.eui.euiColorLightShade}; - border-radius: ${({ theme }) => theme.eui.paddingSizes.xs}; + border-radius: ${({ theme }) => theme.eui.euiSizeXS}; } `; @@ -352,7 +352,7 @@ export const EventsTdContent = styled.div.attrs(({ className }) => ({ font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; line-height: ${({ theme }) => theme.eui.euiLineHeight}; min-width: 0; - padding: ${({ theme }) => theme.eui.paddingSizes.xs}; + padding: ${({ theme }) => theme.eui.euiSizeXS}; text-align: ${({ textAlign }) => textAlign}; width: ${({ width }) => width != null @@ -360,7 +360,7 @@ export const EventsTdContent = styled.div.attrs(({ className }) => ({ : '100%'}; /* Using width: 100% instead of flex: 1 and max-width: 100% for IE11 */ button.euiButtonIcon { - margin-left: ${({ theme }) => `-${theme.eui.paddingSizes.xs}`}; + margin-left: ${({ theme }) => `-${theme.eui.euiSizeXS}`}; } `; @@ -468,8 +468,7 @@ export const FullWidthFlexGroup = styled(EuiFlexGroup)<{ $visible?: boolean }>` `; export const UpdatedFlexGroup = styled(EuiFlexGroup)<{ $view?: ViewSelection }>` - ${({ $view, theme }) => - $view === 'gridView' ? `margin-right: ${theme.eui.paddingSizes.xl};` : ''} + ${({ $view, theme }) => ($view === 'gridView' ? `margin-right: ${theme.eui.euiSizeXL};` : '')} position: absolute; z-index: ${({ theme }) => theme.eui.euiZLevel1}; right: 0px; @@ -483,6 +482,6 @@ export const AlertCount = styled.span` font-size: ${({ theme }) => theme.eui.euiFontSizeXS}; font-weight: ${({ theme }) => theme.eui.euiFontWeightSemiBold}; border-right: ${({ theme }) => theme.eui.euiBorderThin}; - margin-right: ${({ theme }) => theme.eui.paddingSizes.s}; - padding-right: ${({ theme }) => theme.eui.paddingSizes.m}; + margin-right: ${({ theme }) => theme.eui.euiSizeS}; + padding-right: ${({ theme }) => theme.eui.euiSizeM}; `; diff --git a/x-pack/plugins/timelines/public/store/t_grid/types.ts b/x-pack/plugins/timelines/public/store/t_grid/types.ts index 8e0b7e995dbcd..c7127f16385af 100644 --- a/x-pack/plugins/timelines/public/store/t_grid/types.ts +++ b/x-pack/plugins/timelines/public/store/t_grid/types.ts @@ -54,6 +54,7 @@ export enum TimelineId { casePage = 'timeline-case', test = 'test', // Reserved for testing purposes alternateTest = 'alternateTest', + kubernetesPageSessions = 'kubernetes-page-sessions', } export interface InitialyzeTGridSettings extends Partial { diff --git a/x-pack/plugins/transform/common/api_schemas/type_guards.ts b/x-pack/plugins/transform/common/api_schemas/type_guards.ts index 567eeb030e22d..821eda892deb3 100644 --- a/x-pack/plugins/transform/common/api_schemas/type_guards.ts +++ b/x-pack/plugins/transform/common/api_schemas/type_guards.ts @@ -7,9 +7,10 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; + import type { EsIndex } from '../types/es_index'; import type { EsIngestPipeline } from '../types/es_ingest_pipeline'; -import { isPopulatedObject } from '../shared_imports'; // To be able to use the type guards on the client side, we need to make sure we don't import // the code of '@kbn/config-schema' but just its types, otherwise the client side code will diff --git a/x-pack/plugins/transform/common/shared_imports.ts b/x-pack/plugins/transform/common/shared_imports.ts index 0566086046d0e..fd00440e07c5b 100644 --- a/x-pack/plugins/transform/common/shared_imports.ts +++ b/x-pack/plugins/transform/common/shared_imports.ts @@ -8,7 +8,6 @@ export type { ChartData } from '@kbn/ml-plugin/common'; export { composeValidators, - isPopulatedObject, isRuntimeMappings, patternValidator, isRuntimeField, diff --git a/x-pack/plugins/transform/common/types/data_view.ts b/x-pack/plugins/transform/common/types/data_view.ts index 98787a1281dbb..b541254971c35 100644 --- a/x-pack/plugins/transform/common/types/data_view.ts +++ b/x-pack/plugins/transform/common/types/data_view.ts @@ -6,8 +6,7 @@ */ import type { DataView } from '@kbn/data-views-plugin/common'; - -import { isPopulatedObject } from '../shared_imports'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; // Custom minimal type guard for DataView to check against the attributes used in transforms code. export function isDataView(arg: any): arg is DataView { diff --git a/x-pack/plugins/transform/common/types/transform.ts b/x-pack/plugins/transform/common/types/transform.ts index a196111bf6678..f4f9437e05d13 100644 --- a/x-pack/plugins/transform/common/types/transform.ts +++ b/x-pack/plugins/transform/common/types/transform.ts @@ -6,8 +6,8 @@ */ import type { EuiComboBoxOptionOption } from '@elastic/eui/src/components/combo_box/types'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { LatestFunctionConfig, PutTransformsRequestSchema } from '../api_schemas/transforms'; -import { isPopulatedObject } from '../shared_imports'; import type { PivotGroupByDict } from './pivot_group_by'; import type { PivotAggDict } from './pivot_aggs'; import type { TransformHealthAlertRule } from './alerting'; diff --git a/x-pack/plugins/transform/common/types/transform_stats.ts b/x-pack/plugins/transform/common/types/transform_stats.ts index 00ffa40b84d3b..2f9319201fd6b 100644 --- a/x-pack/plugins/transform/common/types/transform_stats.ts +++ b/x-pack/plugins/transform/common/types/transform_stats.ts @@ -5,8 +5,9 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; + import { TransformState, TRANSFORM_STATE } from '../constants'; -import { isPopulatedObject } from '../shared_imports'; import { TransformId } from './transform'; export interface TransformStats { diff --git a/x-pack/plugins/transform/common/utils/errors.ts b/x-pack/plugins/transform/common/utils/errors.ts index 2aff8f332b130..c9d81b740f721 100644 --- a/x-pack/plugins/transform/common/utils/errors.ts +++ b/x-pack/plugins/transform/common/utils/errors.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { isPopulatedObject } from '../shared_imports'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; export interface ErrorResponse { body: { diff --git a/x-pack/plugins/transform/public/app/common/pivot_aggs.ts b/x-pack/plugins/transform/public/app/common/pivot_aggs.ts index 9045191a779cb..4b986659fe633 100644 --- a/x-pack/plugins/transform/public/app/common/pivot_aggs.ts +++ b/x-pack/plugins/transform/public/app/common/pivot_aggs.ts @@ -8,13 +8,13 @@ import { FC } from 'react'; import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/data-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { AggName } from '../../../common/types/aggregations'; import type { Dictionary } from '../../../common/types/common'; import type { EsFieldName } from '../../../common/types/fields'; import type { PivotAgg, PivotSupportedAggs } from '../../../common/types/pivot_aggs'; import { PIVOT_SUPPORTED_AGGS } from '../../../common/types/pivot_aggs'; -import { isPopulatedObject } from '../../../common/shared_imports'; import { getAggFormConfig } from '../sections/create_transform/components/step_define/common/get_agg_form_config'; import { PivotAggsConfigFilter } from '../sections/create_transform/components/step_define/common/filter_agg/types'; diff --git a/x-pack/plugins/transform/public/app/common/pivot_group_by.ts b/x-pack/plugins/transform/public/app/common/pivot_group_by.ts index dd9a63088e791..b0fa78e8a902f 100644 --- a/x-pack/plugins/transform/public/app/common/pivot_group_by.ts +++ b/x-pack/plugins/transform/public/app/common/pivot_group_by.ts @@ -6,11 +6,11 @@ */ import { KBN_FIELD_TYPES } from '@kbn/data-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { AggName } from '../../../common/types/aggregations'; import { Dictionary } from '../../../common/types/common'; import { EsFieldName } from '../../../common/types/fields'; import { GenericAgg } from '../../../common/types/pivot_group_by'; -import { isPopulatedObject } from '../../../common/shared_imports'; import { PivotAggsConfigWithUiSupport } from './pivot_aggs'; export enum PIVOT_SUPPORTED_GROUP_BY_AGGS { diff --git a/x-pack/plugins/transform/public/app/common/request.ts b/x-pack/plugins/transform/public/app/common/request.ts index 350f57a3bcf58..4700e42a3d946 100644 --- a/x-pack/plugins/transform/public/app/common/request.ts +++ b/x-pack/plugins/transform/public/app/common/request.ts @@ -9,6 +9,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { HttpFetchError } from '@kbn/core/public'; import type { DataView } from '@kbn/data-views-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { DEFAULT_CONTINUOUS_MODE_DELAY, @@ -23,7 +24,6 @@ import type { PutTransformsPivotRequestSchema, PutTransformsRequestSchema, } from '../../../common/api_schemas/transforms'; -import { isPopulatedObject } from '../../../common/shared_imports'; import { DateHistogramAgg, HistogramAgg, TermsAgg } from '../../../common/types/pivot_group_by'; import { isDataView } from '../../../common/types/data_view'; diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts b/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts index 659d525643965..c3db9834a5b54 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts @@ -6,9 +6,9 @@ */ import { i18n } from '@kbn/i18n'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { Privileges } from '../../../../../common/types/privileges'; -import { isPopulatedObject } from '../../../../../common/shared_imports'; export interface Capabilities { canGetTransform: boolean; diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx index 649683182dcab..59f80d743a9a3 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_create/step_create_form.tsx @@ -30,6 +30,7 @@ import { DISCOVER_APP_LOCATOR } from '@kbn/discover-plugin/public'; import { DuplicateDataViewError } from '@kbn/data-plugin/public'; import type { RuntimeField } from '@kbn/data-views-plugin/common'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { PutTransformsResponseSchema } from '../../../../../../common/api_schemas/transforms'; import { isGetTransformsStatsResponseSchema, @@ -49,7 +50,6 @@ import { PutTransformsLatestRequestSchema, PutTransformsPivotRequestSchema, } from '../../../../../../common/api_schemas/transforms'; -import { isPopulatedObject } from '../../../../../../common/shared_imports'; import { isContinuousTransform, isLatestTransform } from '../../../../../../common/types/transform'; import { TransformAlertFlyout } from '../../../../../alerting/transform_alerting_flyout'; diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx index 6f590a0e17892..55ecc18863aa5 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_agg_form.tsx @@ -10,13 +10,13 @@ import { EuiFormRow, EuiIcon, EuiSelect, EuiToolTip } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import useUpdateEffect from 'react-use/lib/useUpdateEffect'; import { DataView } from '@kbn/data-views-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { CreateTransformWizardContext } from '../../../../wizard/wizard'; import { commonFilterAggs, filterAggsFieldSupport } from '../constants'; import { getFilterAggTypeConfig } from '../config'; import type { FilterAggType, PivotAggsConfigFilter } from '../types'; import type { RuntimeMappings } from '../../types'; import { getKibanaFieldTypeFromEsType } from '../../get_pivot_dropdown_options'; -import { isPopulatedObject } from '../../../../../../../../../common/shared_imports'; /** * Resolves supported filters for provided field. diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/top_metrics_agg/config.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/top_metrics_agg/config.ts index 56d17e7973e16..49be7b299712b 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/top_metrics_agg/config.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/top_metrics_agg/config.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { isPivotAggsConfigWithUiSupport, isSpecialSortField, @@ -16,7 +17,6 @@ import { } from '../../../../../../common/pivot_aggs'; import { PivotAggsConfigTopMetrics } from './types'; import { TopMetricsAggForm } from './components/top_metrics_agg_form'; -import { isPopulatedObject } from '../../../../../../../../common/shared_imports'; /** * Gets initial basic configuration of the top_metrics aggregation. diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts index e97d47864313c..a8a9b5c1e35b0 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts @@ -6,6 +6,7 @@ */ import { KBN_FIELD_TYPES } from '@kbn/data-plugin/public'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { EsFieldName } from '../../../../../../../common/types/fields'; @@ -24,7 +25,7 @@ import { } from '../../../../../../../common/types/transform'; import { LatestFunctionConfig } from '../../../../../../../common/api_schemas/transforms'; -import { isPopulatedObject, RUNTIME_FIELD_TYPES } from '../../../../../../../common/shared_imports'; +import { RUNTIME_FIELD_TYPES } from '../../../../../../../common/shared_imports'; export interface ErrorMessage { query: string; diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/use_edit_transform_flyout.ts b/x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/use_edit_transform_flyout.ts index eb9adbb45b5b4..a2dc9148bf03f 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/use_edit_transform_flyout.ts +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/edit_transform_flyout/use_edit_transform_flyout.ts @@ -11,8 +11,8 @@ import { merge } from 'lodash'; import { useReducer } from 'react'; import { i18n } from '@kbn/i18n'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; -import { isPopulatedObject } from '../../../../../../common/shared_imports'; import { PostTransformsUpdateRequestSchema } from '../../../../../../common/api_schemas/update_transforms'; import { DEFAULT_TRANSFORM_FREQUENCY, diff --git a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/expanded_row.tsx b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/expanded_row.tsx index 84110e67d701e..6477e33a5c5a7 100644 --- a/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/expanded_row.tsx +++ b/x-pack/plugins/transform/public/app/sections/transform_management/components/transform_list/expanded_row.tsx @@ -10,6 +10,7 @@ import React, { FC } from 'react'; import { EuiButtonEmpty, EuiTabbedContent } from '@elastic/eui'; import { Optional } from '@kbn/utility-types'; import { i18n } from '@kbn/i18n'; +import { stringHash } from '@kbn/ml-string-hash'; import moment from 'moment-timezone'; import { TransformListRow } from '../../../../common'; @@ -28,23 +29,6 @@ function getItemDescription(value: any) { return value.toString(); } -/** - * Creates a deterministic number based hash out of a string. - */ -export function stringHash(str: string): number { - let hash = 0; - let chr = 0; - if (str.length === 0) { - return hash; - } - for (let i = 0; i < str.length; i++) { - chr = str.charCodeAt(i); - hash = (hash << 5) - hash + chr; // eslint-disable-line no-bitwise - hash |= 0; // eslint-disable-line no-bitwise - } - return hash < 0 ? hash * -2 : hash; -} - type Item = SectionItem; interface Props { diff --git a/x-pack/plugins/transform/server/routes/api/transforms_nodes.ts b/x-pack/plugins/transform/server/routes/api/transforms_nodes.ts index 426dc3d4fa342..a5f8f014430c7 100644 --- a/x-pack/plugins/transform/server/routes/api/transforms_nodes.ts +++ b/x-pack/plugins/transform/server/routes/api/transforms_nodes.ts @@ -7,8 +7,9 @@ import Boom from '@hapi/boom'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; + import { NODES_INFO_PRIVILEGES } from '../../../common/constants'; -import { isPopulatedObject } from '../../../common/shared_imports'; import { RouteDependencies } from '../../types'; diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index 3c492c1443bf7..ae829d05815fb 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -209,48 +209,14 @@ "xpack.lens.dragDrop.announce.cancelled": "Mouvement annulé. {label} revenu à sa position initiale", "xpack.lens.dragDrop.announce.cancelledItem": "Mouvement annulé. {label} revenu au groupe {groupLabel} à la position {position}", "xpack.lens.dragDrop.announce.combine.short": " Maintenir la touche Contrôle enfoncée pour combiner", - "xpack.lens.dragDrop.announce.dropped.combineCompatible": "Combinaison de {label} avec {dropGroupLabel} à la position {dropPosition} et de {dropLabel} avec {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.combineIncompatible": "Conversion de {label} en {nextLabel} dans le groupe {groupLabel} à la position {position} et combinaison avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}", - "xpack.lens.dragDrop.announce.dropped.duplicated": "{label} dupliqué dans le groupe {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.duplicateIncompatible": "Copie de {label} convertie en {nextLabel} et ajoutée au groupe {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.moveCompatible": "{label} déplacé dans le groupe {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.moveIncompatible": "{label} converti en {nextLabel} et déplacé dans le groupe {groupLabel} à la position {position}", "xpack.lens.dragDrop.announce.dropped.reordered": "{label} réorganisé dans le groupe {groupLabel} de la position {prevPosition} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.replaceDuplicateIncompatible": "Copie de {label} convertie en {nextLabel} et {dropLabel} remplacé dans le groupe {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.replaceIncompatible": "{label} converti en {nextLabel} et {dropLabel} remplacé dans le groupe {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.swapCompatible": "{label} déplacé dans {dropGroupLabel} à la position {dropPosition} et {dropLabel} dans {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.dropped.swapIncompatible": "{label} converti en {nextLabel} dans le groupe {groupLabel} à la position {position} et permuté avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}", - "xpack.lens.dragDrop.announce.droppedDefault": "{label} ajouté dans le groupe {dropGroupLabel} à la position {position}", "xpack.lens.dragDrop.announce.droppedNoPosition": "{label} ajouté à {dropLabel}", "xpack.lens.dragDrop.announce.duplicate.short": " Maintenez la touche Alt ou Option enfoncée pour dupliquer.", - "xpack.lens.dragDrop.announce.duplicated.combine": "Combiner {dropLabel} avec {label} dans {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.duplicated.replace": "{dropLabel} remplacé par {label} dans {groupLabel} à la position {position}", - "xpack.lens.dragDrop.announce.duplicated.replaceDuplicateCompatible": "{dropLabel} remplacé par une copie de {label} dans {groupLabel} à la position {position}", "xpack.lens.dragDrop.announce.lifted": "{label} levé", - "xpack.lens.dragDrop.announce.selectedTarget.combine": "Combinez {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition} avec {label}. Appuyez sur la barre d’espace ou sur Entrée pour combiner.", - "xpack.lens.dragDrop.announce.selectedTarget.combineCompatible": "Combinez {label} dans le groupe {groupLabel} à la position {position} avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}. Maintenez la touche Contrôle enfoncée et appuyez sur la barre d’espace ou sur Entrée pour combiner.", - "xpack.lens.dragDrop.announce.selectedTarget.combineIncompatible": "Convertissez {label} en {nextLabel} dans le groupe {groupLabel} à la position {position} et combinez avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}. Maintenez la touche Contrôle enfoncée et appuyez sur la barre d’espace ou sur Entrée pour combiner.", - "xpack.lens.dragDrop.announce.selectedTarget.combineMain": "Vous faites glisser {label} à partir de {groupLabel} à la position {position} sur {dropLabel} à partir du groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d’espace ou sur Entrée pour combiner {dropLabel} avec {label}.{duplicateCopy}{swapCopy}{combineCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.default": "Ajoutez {label} au groupe {dropGroupLabel} à la position {position}. Appuyer sur la barre d'espace ou sur Entrée pour ajouter", "xpack.lens.dragDrop.announce.selectedTarget.defaultNoPosition": "Ajoutez {label} à {dropLabel}. Appuyer sur la barre d'espace ou sur Entrée pour ajouter", - "xpack.lens.dragDrop.announce.selectedTarget.duplicated": "Dupliquez {label} dans le groupe {dropGroupLabel} à la position {position}. Maintenir la touche Alt ou Option enfoncée et appuyer sur la barre d'espace ou sur Entrée pour dupliquer", - "xpack.lens.dragDrop.announce.selectedTarget.duplicatedInGroup": "Dupliquez {label} dans le groupe {dropGroupLabel} à la position {position}. Appuyer sur la barre d'espace ou sur Entrée pour dupliquer", - "xpack.lens.dragDrop.announce.selectedTarget.duplicateIncompatible": "Convertissez la copie de {label} en {nextLabel} et ajoutez-la au groupe {groupLabel} à la position {position}. Maintenir la touche Alt ou Option enfoncée et appuyer sur la barre d'espace ou sur Entrée pour dupliquer", - "xpack.lens.dragDrop.announce.selectedTarget.moveCompatible": "Déplacez {label} dans le groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d'espace ou sur Entrée pour déplacer", - "xpack.lens.dragDrop.announce.selectedTarget.moveCompatibleMain": "Vous faites glisser {label} de {groupLabel} à la position {position} vers la position {dropPosition} dans le groupe {dropGroupLabel}. Appuyez sur la barre d'espace ou sur Entrée pour déplacer.{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatible": "Convertissez {label} en {nextLabel} et déplacez-le dans le groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d'espace ou sur Entrée pour déplacer", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatibleMain": "Vous faites glisser {label} de {groupLabel} à la position {position} vers la position {dropPosition} dans le groupe {dropGroupLabel}. Appuyez sur la barre d'espace ou sur Entrée pour convertir {label} en {nextLabel} et déplacer.{duplicateCopy}{swapCopy}", "xpack.lens.dragDrop.announce.selectedTarget.noSelected": "Aucune cible sélectionnée. Utiliser les touches fléchées pour sélectionner une cible", "xpack.lens.dragDrop.announce.selectedTarget.reordered": "Réorganisez {label} dans le groupe {groupLabel} de la position {prevPosition} à la position {position}. Appuyer sur la barre d'espace ou sur Entrée pour réorganiser", "xpack.lens.dragDrop.announce.selectedTarget.reorderedBack": "{label} revenu à sa position initiale {prevPosition}", - "xpack.lens.dragDrop.announce.selectedTarget.replace": "Remplacez {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition} avec {label}. Appuyez sur la barre d'espace ou sur Entrée pour remplacer.", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateCompatible": "Dupliquez {label} et remplacez {dropLabel} dans {groupLabel} à la position {position}. Maintenir la touche Alt ou Option enfoncée et appuyer sur la barre d'espace ou sur Entrée pour dupliquer et remplacer", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateIncompatible": "Convertissez la copie de {label} en {nextLabel} et remplacez {dropLabel} dans le groupe {groupLabel} à la position {position}. Maintenir la touche Alt ou Option enfoncée et appuyer sur la barre d'espace ou sur Entrée pour dupliquer et remplacer", - "xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatible": "Convertissez {label} en {nextLabel} et remplacez {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d'espace ou sur Entrée pour remplacer", - "xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatibleMain": "Vous faites glisser {label} à partir de {groupLabel} à la position {position} sur {dropLabel} à partir du groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d'espace ou sur Entrée pour convertir {label} en {nextLabel} et remplacer {dropLabel}.{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.replaceMain": "Vous faites glisser {label} à partir de {groupLabel} à la position {position} sur {dropLabel} à partir du groupe {dropGroupLabel} à la position {dropPosition}. Appuyer sur la barre d'espace ou sur Entrée pour remplacer {dropLabel} par {label}.{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.swapCompatible": "Permutez {label} dans le groupe {groupLabel} à la position {position} avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}. Maintenir la touche Maj enfoncée tout en appuyant sur la barre d'espace ou sur Entrée pour permuter", - "xpack.lens.dragDrop.announce.selectedTarget.swapIncompatible": "Convertir {label} en {nextLabel} dans le groupe {groupLabel} à la position {position} et permutez avec {dropLabel} dans le groupe {dropGroupLabel} à la position {dropPosition}. Maintenir la touche Maj enfoncée tout en appuyant sur la barre d'espace ou sur Entrée pour permuter", "xpack.lens.dragDrop.announce.swap.short": " Maintenez la touche Maj enfoncée pour permuter.", "xpack.lens.dragDrop.combine": "Combiner", "xpack.lens.dragDrop.control": "Contrôle", @@ -365,8 +331,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "Nom de la colonne dans laquelle le taux de compteur résultant sera stocké", "xpack.lens.functions.counterRate.help": "Calcule le taux de compteur d'une colonne dans un tableau de données", "xpack.lens.functions.lastValue.missingSortField": "Cette vue de données ne contient aucun champ de date.", - "xpack.lens.functions.renameColumns.help": "Aide pour renommer les colonnes d'un tableau de données", - "xpack.lens.functions.renameColumns.idMap.help": "Un objet encodé JSON dans lequel les clés sont les anciens ID de colonne et les valeurs sont les nouveaux ID correspondants. Tous les autres ID de colonne sont conservés.", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "L'ID de colonne de date {columnId} n'existe pas.", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "Impossible de récupérer les informations d'histogramme des dates", "xpack.lens.gauge.addLayer": "Visualisation", @@ -5338,11 +5302,10 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "ID du localisateur non spécifié. Spécifiez le paramètre de recherche \"l\" dans l'URL ; ce devrait être un ID de localisateur existant.", "share.urlService.redirect.RedirectManager.missingParamParams": "Paramètres du localisateur non spécifiés. Spécifiez le paramètre de recherche \"p\" dans l'URL ; ce devrait être un objet sérialisé JSON des paramètres du localisateur.", "share.urlService.redirect.RedirectManager.missingParamVersion": "Version des paramètres du localisateur non spécifiée. Spécifiez le paramètre de recherche \"v\" dans l'URL ; ce devrait être la version de Kibana au moment de la génération des paramètres du localisateur.", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "Utilisez Elastic Agent pour collecter de manière simple et unifiée les données de vos machines.", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "Cette intégration n'est pas encore activée. Votre administrateur possède les autorisations requises pour l’activer.", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "Contactez votre administrateur", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "Ajouter Elastic Agent", - "sharedUXComponents.pageTemplate.noDataCard.description": "Continuer sans collecter de données", + "sharedUXPackages.card.noData.description": "Utilisez Elastic Agent pour collecter de manière simple et unifiée les données de vos machines.", + "sharedUXPackages.card.noData.noPermission.description": "Cette intégration n'est pas encore activée. Votre administrateur possède les autorisations requises pour l’activer.", + "sharedUXPackages.card.noData.noPermission.title": "Contactez votre administrateur", + "sharedUXPackages.card.noData.title": "Ajouter Elastic Agent", "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "Ajouter depuis la bibliothèque", "sharedUXPackages.noDataViewsPrompt.learnMore": "Envie d'en savoir plus ?", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "Lisez les documents", diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index fa1ce7b24c45c..e8e2fc397bf63 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -214,43 +214,14 @@ "xpack.lens.dragDrop.announce.cancelled": "移動がキャンセルされました。{label}は初期位置に戻りました", "xpack.lens.dragDrop.announce.cancelledItem": "移動がキャンセルされました。{label}は位置{position}の{groupLabel}グループに戻りました", "xpack.lens.dragDrop.announce.combine.short": " Ctrlを押しながら結合します", - "xpack.lens.dragDrop.announce.dropped.combineCompatible": "位置{dropPosition}で{label}を{dropGroupLabel}に移動し、位置{position}で{dropLabel}を {groupLabel}グループに結合しました", - "xpack.lens.dragDrop.announce.dropped.combineIncompatible": "位置{position}で{label}を{groupLabel}の{nextLabel}に変換し、位置{dropPosition}で{dropGroupLabel}グループの{dropLabel}と結合しました", - "xpack.lens.dragDrop.announce.dropped.duplicated": "位置{position}の{groupLabel}グループで{label}を複製しました", - "xpack.lens.dragDrop.announce.dropped.duplicateIncompatible": "{label}のコピーを{nextLabel}に変換し、位置{position}の{groupLabel}グループに追加しました", - "xpack.lens.dragDrop.announce.dropped.moveCompatible": "位置{position}の{groupLabel}グループに{label}を移動しました", - "xpack.lens.dragDrop.announce.dropped.moveIncompatible": "{label}を{nextLabel}に変換し、位置{position}の{groupLabel}グループに移動しました", "xpack.lens.dragDrop.announce.dropped.reordered": "{groupLabel}グループの{label}を位置{prevPosition}から位置{position}に並べ替えました", - "xpack.lens.dragDrop.announce.dropped.replaceDuplicateIncompatible": "{label}のコピーを{nextLabel}に変換し、位置{position}の{groupLabel}グループで{dropLabel}を置き換えました", - "xpack.lens.dragDrop.announce.dropped.replaceIncompatible": "{label}を{nextLabel}に変換し、位置{position}の{groupLabel}グループで{dropLabel}を置き換えました", - "xpack.lens.dragDrop.announce.dropped.swapCompatible": "位置{dropPosition}で{label}を{dropGroupLabel}に移動し、位置{position}で{dropLabel}を {groupLabel}グループに移動しました", - "xpack.lens.dragDrop.announce.dropped.swapIncompatible": "位置{position}で{label}を{groupLabel}の{nextLabel}に変換し、位置{dropPosition}で{dropGroupLabel}グループの{dropLabel}と入れ替えました", - "xpack.lens.dragDrop.announce.droppedDefault": "位置{position}の{dropGroupLabel}グループで{label}を追加しました", "xpack.lens.dragDrop.announce.droppedNoPosition": "{label}を{dropLabel}に追加しました", "xpack.lens.dragDrop.announce.duplicate.short": " AltキーまたはOptionを押し続けると複製します。", - "xpack.lens.dragDrop.announce.duplicated.combine": "位置{position}の{groupLabel}で{dropLabel}を{label}と結合しました", - "xpack.lens.dragDrop.announce.duplicated.replace": "位置{position}の{groupLabel}で{dropLabel}を{label}に置き換えました", - "xpack.lens.dragDrop.announce.duplicated.replaceDuplicateCompatible": "位置{position}の{groupLabel}で{dropLabel}を{label}のコピーに置き換えました", "xpack.lens.dragDrop.announce.lifted": "{label}を上げました", - "xpack.lens.dragDrop.announce.selectedTarget.combineCompatible": "位置{position}の{groupLabel}の{label}を、位置{dropPosition}の{dropGroupLabel}グループの{dropLabel}と結合します。Ctrlキーを押しながらスペースバーまたはEnterキーを押すと、結合します", - "xpack.lens.dragDrop.announce.selectedTarget.combineIncompatible": "位置{position}で{label}を{groupLabel}の{nextLabel}に変換し、位置{dropPosition}で{dropGroupLabel}グループの{dropLabel}と結合します。Ctrlキーを押しながらスペースバーまたはEnterキーを押すと、結合します", - "xpack.lens.dragDrop.announce.selectedTarget.default": "位置{position}の{dropGroupLabel}グループに{label}を追加しました。スペースまたはEnterを押して追加します", "xpack.lens.dragDrop.announce.selectedTarget.defaultNoPosition": "{label}を{dropLabel}に追加します。スペースまたはEnterを押して追加します", - "xpack.lens.dragDrop.announce.selectedTarget.duplicated": "位置{position}の{dropGroupLabel}グループに{label}を複製しました。AltまたはOptionを押しながらスペースバーまたはEnterキーを押すと、複製します", - "xpack.lens.dragDrop.announce.selectedTarget.duplicatedInGroup": "位置{position}の{dropGroupLabel}グループに{label}を複製しました。スペースまたはEnterを押して複製します", - "xpack.lens.dragDrop.announce.selectedTarget.duplicateIncompatible": "{label}のコピーを{nextLabel}に変換し、位置{position}で{groupLabel}グループに移動します。AltまたはOptionを押しながらスペースバーまたはEnterキーを押すと、複製します", - "xpack.lens.dragDrop.announce.selectedTarget.moveCompatibleMain": "位置{position}で{groupLabel}の{label}を{dropGroupLabel}グループの位置{dropPosition}にドラッグしています。スペースバーまたはEnterキーを押すと移動します。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatible": "{label}を{nextLabel}に変換し、位置{dropPosition}で{dropGroupLabel}グループに移動します。スペースまたはEnterを押して移動します", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatibleMain": "位置{position}で{groupLabel}の{label}を{dropGroupLabel}グループの位置{dropPosition}にドラッグしています。スペースバーまたはEnterキーを押して、{label}を{nextLabel}に変換して移動します。{duplicateCopy}{swapCopy}", "xpack.lens.dragDrop.announce.selectedTarget.noSelected": "対象が選択されていません。矢印キーを使用して対象を選択してください", "xpack.lens.dragDrop.announce.selectedTarget.reordered": "{groupLabel}グループの{label}を位置{prevPosition}から位置{position}に並べ替えます。スペースまたはEnterを押して並べ替えます", "xpack.lens.dragDrop.announce.selectedTarget.reorderedBack": "{label}は初期位置{prevPosition}に戻りました", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateCompatible": "位置{position}で{label}を複製し、{groupLabel}グループで{dropLabel}を置き換えます。AltまたはOptionを押しながらスペースバーまたはEnterキーを押すと、複製して置換します", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateIncompatible": "{label}のコピーを{nextLabel}に変換し、位置{position}で{groupLabel}グループの{dropLabel}を置き換えます。AltまたはOptionを押しながらスペースバーまたはEnterキーを押すと、複製して置換します", - "xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatibleMain": "位置{position}の{groupLabel}の{label}を、位置{dropPosition}の{dropGroupLabel}グループの{dropLabel}にドラッグしています。スペースバーまたはEnterキーを押して、{label}を{nextLabel}に変換して、{dropLabel}を置き換えます。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.replaceMain": "位置{position}の{groupLabel}の{label}を、位置{dropPosition}の{dropGroupLabel}グループの{dropLabel}にドラッグしています。スペースまたはEnterを押して、{dropLabel}を{label}で置き換えます。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.swapCompatible": "位置{position}の{groupLabel}の{label}を、位置{dropPosition}の{dropGroupLabel}グループの{dropLabel}と入れ替えます。Shiftキーを押しながらスペースバーまたはEnterキーを押すと、入れ替えます", - "xpack.lens.dragDrop.announce.selectedTarget.swapIncompatible": "位置{position}で{label}を{groupLabel}の{nextLabel}に変換し、位置{dropPosition}で{dropGroupLabel}グループの{dropLabel}と入れ替えます。Shiftキーを押しながらスペースバーまたはEnterキーを押すと、入れ替えます", "xpack.lens.dragDrop.announce.swap.short": " Shiftキーを押すと入れ替えます。", "xpack.lens.dragDrop.combine": "結合", "xpack.lens.dragDrop.control": "Control", @@ -367,8 +338,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "結果のカウンターレートを格納する列の名前", "xpack.lens.functions.counterRate.help": "データテーブルの列のカウンターレートを計算します", "xpack.lens.functions.lastValue.missingSortField": "このデータビューには日付フィールドが含まれていません", - "xpack.lens.functions.renameColumns.help": "データベースの列の名前の変更をアシストします", - "xpack.lens.functions.renameColumns.idMap.help": "キーが古い列 ID で値が対応する新しい列 ID となるように JSON エンコーディングされたオブジェクトです。他の列 ID はすべてのそのままです。", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "指定した dateColumnId {columnId} は存在しません。", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "日付ヒストグラム情報を取得できませんでした", "xpack.lens.gauge.addLayer": "ビジュアライゼーション", @@ -5440,11 +5409,10 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "ロケｰターIDが指定されていません。URLで「l」検索パラメーターを指定します。これは既存のロケｰターIDにしてください。", "share.urlService.redirect.RedirectManager.missingParamParams": "ロケーターパラメーターが指定されていません。URLで「p」検索パラメーターを指定します。これはロケーターパラメーターのJSONシリアル化オブジェクトにしてください。", "share.urlService.redirect.RedirectManager.missingParamVersion": "ロケーターパラメーターバージョンが指定されていません。URLで「v」検索パラメーターを指定します。これはロケーターパラメーターが生成されたときのKibanaのリリースバージョンです。", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "Elasticエージェントを使用すると、シンプルで統一された方法でコンピューターからデータを収集するできます。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "この統合はまだ有効ではありません。管理者にはオンにするために必要なアクセス権があります。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "管理者にお問い合わせください", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "Elasticエージェントの追加", - "sharedUXComponents.pageTemplate.noDataCard.description": "データを収集せずに続行", + "sharedUXPackages.card.noData.description": "Elasticエージェントを使用すると、シンプルで統一された方法でコンピューターからデータを収集するできます。", + "sharedUXPackages.card.noData.noPermission.description": "この統合はまだ有効ではありません。管理者にはオンにするために必要なアクセス権があります。", + "sharedUXPackages.card.noData.noPermission.title": "管理者にお問い合わせください", + "sharedUXPackages.card.noData.title": "Elasticエージェントの追加", "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "ライブラリから追加", "sharedUXPackages.noDataViewsPrompt.learnMore": "詳細について", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "ドキュメントを読む", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index 9bcc45a9ca1ab..09d512eae30db 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -214,48 +214,14 @@ "xpack.lens.dragDrop.announce.cancelled": "移动已取消。{label} 将返回至其初始位置", "xpack.lens.dragDrop.announce.cancelledItem": "移动已取消。{label} 返回至 {groupLabel} 组中的位置 {position}", "xpack.lens.dragDrop.announce.combine.short": " 按住 Control 键组合", - "xpack.lens.dragDrop.announce.dropped.combineCompatible": "已将 {label} 组合到 {dropGroupLabel} 中的位置 {dropPosition} 并将 {dropLabel} 组合到组 {groupLabel} 中的位置 {position}", - "xpack.lens.dragDrop.announce.dropped.combineIncompatible": "已将 {label} 转换为组 {groupLabel} 中位置 {position} 上的 {nextLabel}，并与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 组合", - "xpack.lens.dragDrop.announce.dropped.duplicated": "已在 {groupLabel} 组中的位置 {position} 复制 {label}", - "xpack.lens.dragDrop.announce.dropped.duplicateIncompatible": "已将 {label} 的副本转换为 {nextLabel} 并添加 {groupLabel} 组中的位置 {position}", - "xpack.lens.dragDrop.announce.dropped.moveCompatible": "已将 {label} 移到 {groupLabel} 组中的位置 {position}", - "xpack.lens.dragDrop.announce.dropped.moveIncompatible": "已将 {label} 转换为 {nextLabel} 并移到 {groupLabel} 组中的位置 {position}", "xpack.lens.dragDrop.announce.dropped.reordered": "已将 {groupLabel} 组中的 {label} 从位置 {prevPosition} 重新排到位置 {position}", - "xpack.lens.dragDrop.announce.dropped.replaceDuplicateIncompatible": "已将 {label} 的副本转换为 {nextLabel} 并替换了 {groupLabel} 组中位置 {position} 上的 {dropLabel}", - "xpack.lens.dragDrop.announce.dropped.replaceIncompatible": "已将 {label} 转换为 {nextLabel} 并替换了 {groupLabel} 组中位置 {position} 上的 {dropLabel}", - "xpack.lens.dragDrop.announce.dropped.swapCompatible": "已将 {label} 移至 {dropGroupLabel} 中的位置 {dropPosition} 并将 {dropLabel} 移至组 {groupLabel} 中的位置 {position}", - "xpack.lens.dragDrop.announce.dropped.swapIncompatible": "已将 {label} 转换为组 {groupLabel} 中位置 {position} 上的 {nextLabel}，并与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 交换", - "xpack.lens.dragDrop.announce.droppedDefault": "已将 {label} 添加到 {dropGroupLabel} 组中的位置 {position}", "xpack.lens.dragDrop.announce.droppedNoPosition": "已将 {label} 添加到 {dropLabel}", "xpack.lens.dragDrop.announce.duplicate.short": " 按住 alt 或 option 键以复制。", - "xpack.lens.dragDrop.announce.duplicated.combine": "将 {dropLabel} 与 {groupLabel} 中位置 {position} 上的 {label} 组合", - "xpack.lens.dragDrop.announce.duplicated.replace": "已将 {groupLabel} 组中位置 {position} 上的 {dropLabel} 替换为 {label}", - "xpack.lens.dragDrop.announce.duplicated.replaceDuplicateCompatible": "已将 {groupLabel} 组中位置 {position} 上的 {dropLabel} 替换为 {label} 的副本", "xpack.lens.dragDrop.announce.lifted": "已提升 {label}", - "xpack.lens.dragDrop.announce.selectedTarget.combine": "将 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel} 与 {label} 组合。按空格键或 enter 键组合。", - "xpack.lens.dragDrop.announce.selectedTarget.combineCompatible": "将组 {groupLabel} 中位置 {position} 上的 {label} 与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 组合。按住 Control 键并按空格键或 enter 键组合", - "xpack.lens.dragDrop.announce.selectedTarget.combineIncompatible": "将 {label} 转换为组 {groupLabel} 中位置 {position} 上的 {nextLabel}，并与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 组合。按住 Control 键并按空格键或 enter 键组合", - "xpack.lens.dragDrop.announce.selectedTarget.combineMain": "您正将 {groupLabel} 中位置 {position} 上的{label} 拖到 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel}。按空格键或 enter 键以将 {dropLabel} 与 {label} 组合。{duplicateCopy}{swapCopy}{combineCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.default": "将 {label} 添加到 {dropGroupLabel} 组中的位置 {position}。按空格键或 enter 键添加", "xpack.lens.dragDrop.announce.selectedTarget.defaultNoPosition": "将 {label} 添加到 {dropLabel}。按空格键或 enter 键添加", - "xpack.lens.dragDrop.announce.selectedTarget.duplicated": "将 {label} 复制到 {dropGroupLabel} 组中的位置 {position}。按住 Alt 或 Option 并按空格键或 enter 键以复制", - "xpack.lens.dragDrop.announce.selectedTarget.duplicatedInGroup": "将 {label} 复制到 {dropGroupLabel} 组中的位置 {position}。按空格键或 enter 键复制", - "xpack.lens.dragDrop.announce.selectedTarget.duplicateIncompatible": "将 {label} 转换为 {nextLabel} 并移到 {groupLabel} 组中的位置 {position}。按住 Alt 或 Option 并按空格键或 enter 键以复制", - "xpack.lens.dragDrop.announce.selectedTarget.moveCompatible": "将 {label} 移至 {dropGroupLabel} 组中的位置 {dropPosition}。按空格键或 enter 键移动", - "xpack.lens.dragDrop.announce.selectedTarget.moveCompatibleMain": "您正将 {groupLabel} 中位置 {position} 上的{label} 拖到 {dropGroupLabel} 组中的位置 {dropPosition} 上。按空格键或 enter 键移动。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatible": "将 {label} 转换为 {nextLabel} 并移到 {dropGroupLabel} 组中的位置 {dropPosition}。按空格键或 enter 键移动", - "xpack.lens.dragDrop.announce.selectedTarget.moveIncompatibleMain": "您正将 {groupLabel} 中位置 {position} 上的{label} 拖到 {dropGroupLabel} 组中的位置 {dropPosition} 上。按空格键或 enter 键以将 {label} 转换为 {nextLabel} 并移动。{duplicateCopy}{swapCopy}", "xpack.lens.dragDrop.announce.selectedTarget.noSelected": "未选择任何目标。使用箭头键选择目标", "xpack.lens.dragDrop.announce.selectedTarget.reordered": "将 {groupLabel} 组中的 {label} 从位置 {prevPosition} 重新排到位置 {position}。按空格键或 enter 键重新排列", "xpack.lens.dragDrop.announce.selectedTarget.reorderedBack": "{label} 已返回至其初始位置 {prevPosition}", - "xpack.lens.dragDrop.announce.selectedTarget.replace": "将 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel} 替换为 {label}。按空格键或 enter 键替换。", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateCompatible": "复制 {label} 并替换 {groupLabel} 中位置 {position} 上的 {dropLabel}。按住 Alt 或 Option 并按空格键或 enter 键以复制并替换", - "xpack.lens.dragDrop.announce.selectedTarget.replaceDuplicateIncompatible": "将 {label} 的副本转换为 {nextLabel} 并替换 {groupLabel} 组中位置 {position} 上的 {dropLabel}。按住 Alt 或 Option 并按空格键或 enter 键以复制并替换", - "xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatible": "将 {label} 转换为 {nextLabel} 并替换 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel}。按空格键或 enter 键替换", - "xpack.lens.dragDrop.announce.selectedTarget.replaceIncompatibleMain": "您正将 {groupLabel} 中位置 {position} 上的{label} 拖到 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel}。按空格键或 enter 键以将 {label} 转换为 {nextLabel} 并替换 {dropLabel}。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.replaceMain": "您正将 {groupLabel} 中位置 {position} 上的{label} 拖到 {dropGroupLabel} 组中位置 {dropPosition} 上的 {dropLabel}。按空格键或 enter 键以将 {dropLabel} 替换为 {label}。{duplicateCopy}{swapCopy}", - "xpack.lens.dragDrop.announce.selectedTarget.swapCompatible": "将组 {groupLabel} 中位置 {position} 上的 {label} 与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 交换。按住 Shift 键并按空格键或 enter 键交换", - "xpack.lens.dragDrop.announce.selectedTarget.swapIncompatible": "将 {label} 转换为组 {groupLabel} 中位置 {position} 上的 {nextLabel}，并与组 {dropGroupLabel} 中位置 {dropPosition} 上的 {dropLabel} 交换。按住 Shift 键并按空格键或 enter 键交换", "xpack.lens.dragDrop.announce.swap.short": " 按住 Shift 键交换。", "xpack.lens.dragDrop.combine": "组合", "xpack.lens.dragDrop.control": "Control 键", @@ -372,8 +338,6 @@ "xpack.lens.functions.counterRate.args.outputColumnNameHelpText": "要存储结果计数率的列名称", "xpack.lens.functions.counterRate.help": "在数据表中计算列的计数率", "xpack.lens.functions.lastValue.missingSortField": "此数据视图不包含任何日期字段", - "xpack.lens.functions.renameColumns.help": "用于重命名数据表列的助手", - "xpack.lens.functions.renameColumns.idMap.help": "旧列 ID 为键且相应新列 ID 为值的 JSON 编码对象。所有其他列 ID 都将保留。", "xpack.lens.functions.timeScale.dateColumnMissingMessage": "指定的 dateColumnId {columnId} 不存在。", "xpack.lens.functions.timeScale.timeInfoMissingMessage": "无法获取日期直方图信息", "xpack.lens.gauge.addLayer": "可视化", @@ -5451,11 +5415,10 @@ "share.urlService.redirect.RedirectManager.missingParamLocator": "未指定定位器 ID。在 URL 中指定“l”搜索参数，其应为现有定位器 ID。", "share.urlService.redirect.RedirectManager.missingParamParams": "定位器参数未指定。在 URL 中指定“p”搜索参数，其应为定位器参数的 JSON 序列化对象。", "share.urlService.redirect.RedirectManager.missingParamVersion": "定位器参数版本未指定。在 URL 中指定“v”搜索参数，其应为生成定位器参数时 Kibana 的版本。", - "sharedUXComponents.noDataPage.elasticAgentCard.description": "使用 Elastic 代理以简单统一的方式从您的计算机中收集数据。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.description": "尚未启用此集成。您的管理员具有打开它所需的权限。", - "sharedUXComponents.noDataPage.elasticAgentCard.noPermission.title": "请联系您的管理员", - "sharedUXComponents.noDataPage.elasticAgentCard.title": "添加 Elastic 代理", - "sharedUXComponents.pageTemplate.noDataCard.description": "继续，而不收集数据", + "sharedUXPackages.card.noData.description": "使用 Elastic 代理以简单统一的方式从您的计算机中收集数据。", + "sharedUXPackages.card.noData.noPermission.description": "尚未启用此集成。您的管理员具有打开它所需的权限。", + "sharedUXPackages.card.noData.noPermission.title": "请联系您的管理员", + "sharedUXPackages.card.noData.title": "添加 Elastic 代理", "sharedUXPackages.buttonToolbar.buttons.addFromLibrary.libraryButtonLabel": "从库中添加", "sharedUXPackages.noDataViewsPrompt.learnMore": "希望了解详情？", "sharedUXPackages.noDataViewsPrompt.readDocumentation": "阅读文档", diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.test.tsx index 1c21170005265..39867ca690f0f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.test.tsx @@ -28,7 +28,7 @@ describe('AddMessageVariables', () => { wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); expect( - wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').first().text() + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().text() ).toEqual('{{myVar}}'); }); @@ -51,7 +51,7 @@ describe('AddMessageVariables', () => { wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); expect( - wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').first().text() + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().text() ).toEqual('{{{myVar}}}'); }); @@ -76,10 +76,7 @@ describe('AddMessageVariables', () => { ); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-1-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-1-templated-name"]').last().simulate('click'); expect(onSelectEventHandler).toHaveBeenCalledTimes(1); expect(onSelectEventHandler).toHaveBeenCalledWith({ diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.tsx index 08a824f53e465..0849be3d0f6a9 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.tsx @@ -48,7 +48,7 @@ export const AddMessageVariables: React.FunctionComponent = ({ {templateActionVariable(variable)} -

{variable.description}
+
{variable.description}
 diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/json_editor_with_message_variables.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/json_editor_with_message_variables.test.tsx index 068e4755be165..5349e60a60adb 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/json_editor_with_message_variables.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/json_editor_with_message_variables.test.tsx @@ -41,10 +41,7 @@ describe('JsonEditorWithMessageVariables', () => { const wrapper = mountWithIntl(); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(wrapper.find('[data-test-subj="fooJsonEditor"]').first().prop('value')).toEqual( '{{myVar}}' @@ -66,10 +63,7 @@ describe('JsonEditorWithMessageVariables', () => { ); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(wrapper.find('[data-test-subj="fooJsonEditor"]').first().prop('value')).toEqual( '{{{myVar}}}' diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/text_area_with_message_variables.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/text_area_with_message_variables.test.tsx index 0f3981391a49c..29709d2484d6d 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/text_area_with_message_variables.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/text_area_with_message_variables.test.tsx @@ -30,10 +30,7 @@ describe('TextAreaWithMessageVariables', () => { const wrapper = mountWithIntl(); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(editAction).toHaveBeenCalledTimes(1); expect(editAction).toHaveBeenCalledWith(props.paramsProperty, '{{myVar}}', props.index); @@ -54,10 +51,7 @@ describe('TextAreaWithMessageVariables', () => { ); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(editAction).toHaveBeenCalledTimes(1); expect(editAction).toHaveBeenCalledWith(props.paramsProperty, '{{{myVar}}}', props.index); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/components/text_field_with_message_variables.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/components/text_field_with_message_variables.test.tsx index 43c7ac51591b5..c7a25e19c5c12 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/components/text_field_with_message_variables.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/components/text_field_with_message_variables.test.tsx @@ -30,10 +30,7 @@ describe('TextFieldWithMessageVariables', () => { const wrapper = mountWithIntl(); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(editAction).toHaveBeenCalledTimes(1); expect(editAction).toHaveBeenCalledWith(props.paramsProperty, '{{myVar}}', props.index); @@ -54,10 +51,7 @@ describe('TextFieldWithMessageVariables', () => { ); wrapper.find('[data-test-subj="fooAddVariableButton"]').first().simulate('click'); - wrapper - .find('[data-test-subj="variableMenuButton-0-templated-name"]') - .first() - .simulate('click'); + wrapper.find('[data-test-subj="variableMenuButton-0-templated-name"]').last().simulate('click'); expect(editAction).toHaveBeenCalledTimes(1); expect(editAction).toHaveBeenCalledWith(props.paramsProperty, '{{{myVar}}}', props.index); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx index fc8ad1bb31c09..88e6006a601e7 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx @@ -312,7 +312,10 @@ const mockedRulesData = [ beforeEach(() => { (getIsExperimentalFeatureEnabled as jest.Mock).mockImplementation(() => false); }); -describe('Update Api Key', () => { + +// FLAKY: https://github.com/elastic/kibana/issues/134922 +// FLAKY: https://github.com/elastic/kibana/issues/134923 +describe.skip('Update Api Key', () => { const addSuccess = jest.fn(); const addError = jest.fn(); @@ -398,7 +401,8 @@ describe('Update Api Key', () => { }); }); -describe('rules_list component empty', () => { +// FLAKY: https://github.com/elastic/kibana/issues/134924 +describe.skip('rules_list component empty', () => { let wrapper: ReactWrapper; async function setup() { loadRules.mockResolvedValue({ diff --git a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/threshold.test.tsx b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/threshold.test.tsx index bb94e1d38757a..9486a3212b0ac 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/threshold.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/threshold.test.tsx @@ -83,7 +83,7 @@ describe('threshold expression', () => { /> ); - wrapper.find('[data-test-subj="thresholdPopover"]').first().simulate('click'); + wrapper.find('[data-test-subj="thresholdPopover"]').last().simulate('click'); expect(wrapper.find('[data-test-subj="comparatorOptionsComboBox"]').exists()).toBeTruthy(); expect(wrapper.find('[data-test-subj="alertThresholdInput"]').exists()).toBeTruthy(); @@ -122,7 +122,7 @@ describe('threshold expression', () => { /> ); - wrapper.find('[data-test-subj="thresholdPopover"]').first().simulate('click'); + wrapper.find('[data-test-subj="thresholdPopover"]').last().simulate('click'); expect(wrapper.find('[data-test-subj="comparatorOptionsComboBox"]').exists()).toBeTruthy(); expect(wrapper.find('input[data-test-subj="alertThresholdInput"]').length).toEqual(1); diff --git a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/value.test.tsx b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/value.test.tsx index 6ff6206db456a..116e548e78efc 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/value.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/value.test.tsx @@ -102,7 +102,7 @@ describe('value expression', () => { expect(wrapper.find('[data-test-subj="valueFieldTitle"]').exists()).toBeFalsy(); expect(wrapper.find('[data-test-subj="valueFieldNumber"]').exists()).toBeFalsy(); - wrapper.find('[data-test-subj="valueExpression"]').first().simulate('click'); + wrapper.find('[data-test-subj="valueExpression"]').last().simulate('click'); await act(async () => { await nextTick(); wrapper.update(); @@ -123,7 +123,7 @@ describe('value expression', () => { /> ); - wrapper.find('[data-test-subj="valueExpression"]').first().simulate('click'); + wrapper.find('[data-test-subj="valueExpression"]').last().simulate('click'); await act(async () => { await nextTick(); wrapper.update(); diff --git a/x-pack/plugins/ux/e2e/journeys/core_web_vitals.ts b/x-pack/plugins/ux/e2e/journeys/core_web_vitals.ts index 4138027a6b356..afbec5c055cf1 100644 --- a/x-pack/plugins/ux/e2e/journeys/core_web_vitals.ts +++ b/x-pack/plugins/ux/e2e/journeys/core_web_vitals.ts @@ -29,7 +29,7 @@ journey('Core Web Vitals', async ({ page, params }) => { }); await loginToKibana({ page, - user: { username: 'viewer_user', password: 'changeme' }, + user: { username: 'viewer', password: 'changeme' }, }); }); diff --git a/x-pack/plugins/ux/e2e/journeys/url_ux_query.journey.ts b/x-pack/plugins/ux/e2e/journeys/url_ux_query.journey.ts index f5e8fd19a9557..1762cd22a1186 100644 --- a/x-pack/plugins/ux/e2e/journeys/url_ux_query.journey.ts +++ b/x-pack/plugins/ux/e2e/journeys/url_ux_query.journey.ts @@ -29,7 +29,7 @@ journey('UX URL Query', async ({ page, params }) => { }); await loginToKibana({ page, - user: { username: 'viewer_user', password: 'changeme' }, + user: { username: 'viewer', password: 'changeme' }, }); }); diff --git a/x-pack/plugins/ux/e2e/journeys/ux_js_errors.journey.ts b/x-pack/plugins/ux/e2e/journeys/ux_js_errors.journey.ts index eb61a6e446013..8e124d8a5e4b7 100644 --- a/x-pack/plugins/ux/e2e/journeys/ux_js_errors.journey.ts +++ b/x-pack/plugins/ux/e2e/journeys/ux_js_errors.journey.ts @@ -34,7 +34,7 @@ journey('UX JsErrors', async ({ page, params }) => { }); await loginToKibana({ page, - user: { username: 'viewer_user', password: 'changeme' }, + user: { username: 'viewer', password: 'changeme' }, }); }); diff --git a/x-pack/test/accessibility/apps/dashboard_edit_panel.ts b/x-pack/test/accessibility/apps/dashboard_edit_panel.ts index 20b72e142f5c7..56e854f448412 100644 --- a/x-pack/test/accessibility/apps/dashboard_edit_panel.ts +++ b/x-pack/test/accessibility/apps/dashboard_edit_panel.ts @@ -22,7 +22,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('Dashboard Edit Panel Accessibility', () => { before(async () => { - await esArchiver.load('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns' + ); await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); await kibanaServer.uiSettings.replace({ defaultIndex: 'logstash-*' }); await PageObjects.common.navigateToApp('dashboard'); @@ -31,7 +34,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); after(async () => { - await esArchiver.unload('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); }); it('can open menu', async () => { diff --git a/x-pack/test/accessibility/apps/lens.ts b/x-pack/test/accessibility/apps/lens.ts index 18459b56c0542..854ff1b349e49 100644 --- a/x-pack/test/accessibility/apps/lens.ts +++ b/x-pack/test/accessibility/apps/lens.ts @@ -146,23 +146,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.createLayer(); await PageObjects.lens.switchToVisualization('area'); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_xDimensionPanel > lns-empty-dimension', - operation: 'date_histogram', - field: '@timestamp', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_xDimensionPanel > lns-empty-dimension', + operation: 'date_histogram', + field: '@timestamp', + }); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_yDimensionPanel > lns-empty-dimension', - operation: 'median', - field: 'bytes', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-empty-dimension', + operation: 'median', + field: 'bytes', + }); await a11y.testAppSnapshot(); }); diff --git a/x-pack/test/accessibility/apps/management.ts b/x-pack/test/accessibility/apps/management.ts new file mode 100644 index 0000000000000..9dd3ff4346cfa --- /dev/null +++ b/x-pack/test/accessibility/apps/management.ts @@ -0,0 +1,82 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const PageObjects = getPageObjects([ + 'common', + 'settings', + 'header', + 'indexPatternFieldEditorObjects', + 'indexManagement', + ]); + const esArchiver = getService('esArchiver'); + const kibanaServer = getService('kibanaServer'); + const a11y = getService('a11y'); + + describe('Management', () => { + it('main view', async () => { + await PageObjects.settings.navigateTo(); + await a11y.testAppSnapshot(); + }); + + describe('index management', async () => { + describe('indices', async () => { + it('empty state', async () => { + await PageObjects.settings.clickIndexManagement(); + await a11y.testAppSnapshot(); + }); + describe('indices with data', async () => { + before(async () => { + await esArchiver.loadIfNeeded( + 'test/functional/fixtures/es_archiver/logstash_functional' + ); + await kibanaServer.uiSettings.update({ + defaultIndex: 'logstash-*', + }); + await PageObjects.settings.navigateTo(); + }); + after(async () => { + await esArchiver.unload('test/functional/fixtures/es_archiver/logstash_functional'); + }); + it('index list', async () => { + await a11y.testAppSnapshot(); + }); + + describe('index panel', async () => { + it('index panel - summary', async () => { + await PageObjects.settings.clickIndexManagement(); + await PageObjects.indexManagement.clickIndiceAt(0); + await a11y.testAppSnapshot(); + }); + + it('index panel - settings', async () => { + await PageObjects.indexManagement.clickDetailPanelTabAt(0); + await a11y.testAppSnapshot(); + }); + + it('index panel - mappings', async () => { + await PageObjects.indexManagement.clickDetailPanelTabAt(1); + await a11y.testAppSnapshot(); + }); + + it('index panel - stats', async () => { + await PageObjects.indexManagement.clickDetailPanelTabAt(2); + await a11y.testAppSnapshot(); + }); + + it('index panel - edit settings', async () => { + await PageObjects.indexManagement.clickDetailPanelTabAt(3); + await a11y.testAppSnapshot(); + }); + }); + }); + }); + }); + }); +} diff --git a/x-pack/test/accessibility/apps/snapshot_and_restore.ts b/x-pack/test/accessibility/apps/snapshot_and_restore.ts new file mode 100644 index 0000000000000..aac70396b461d --- /dev/null +++ b/x-pack/test/accessibility/apps/snapshot_and_restore.ts @@ -0,0 +1,124 @@ +/* + * 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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +export default function ({ getService, getPageObjects }: FtrProviderContext) { + const PageObjects = getPageObjects(['common', 'settings', 'header', 'snapshotRestore']); + const a11y = getService('a11y'); + const es = getService('es'); + + async function createRepo(repoName: string) { + await es.snapshot.createRepository({ + name: repoName, + verify: true, + type: 'fs', + repository: { + type: 'fs', + settings: { + location: 'temp', + }, + }, + settings: { + location: 'temp', + }, + }); + } + + describe('Stack management- snapshot restore a11y tests', () => { + before(async () => { + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickSnapshotRestore(); + }); + + describe('empty state', async () => { + it('empty snapshots table', async () => { + await a11y.testAppSnapshot(); + }); + + it('empty repositories table', async () => { + await PageObjects.snapshotRestore.navToRepositories(); + await a11y.testAppSnapshot(); + }); + + it('empty policies table', async () => { + await PageObjects.snapshotRestore.navToPolicies(); + await a11y.testAppSnapshot(); + }); + + it('empty restored snapshots status table', async () => { + await PageObjects.snapshotRestore.navToRestoreStatus(); + await a11y.testAppSnapshot(); + }); + }); + + describe('table views with data', async () => { + const testRepoName = 'testrepo'; + const snapshotName = `testsnapshot${Date.now().toString()}`; + before(async () => { + await createRepo(testRepoName); + await es.snapshot.create({ + repository: testRepoName, + snapshot: snapshotName, + wait_for_completion: true, + }); + + await PageObjects.settings.navigateTo(); + await PageObjects.settings.clickSnapshotRestore(); + }); + it('snapshots table with data', async () => { + await a11y.testAppSnapshot(); + }); + it('repository table with data', async () => { + await PageObjects.snapshotRestore.navToRepositories(); + await a11y.testAppSnapshot(); + }); + + after(async () => { + await es.snapshot.delete({ snapshot: snapshotName, repository: testRepoName }); + await es.snapshot.deleteRepository({ name: [testRepoName] }); + }); + }); + + describe('create policy wizard', async () => { + const testRepoName = 'policyrepo'; + before(async () => { + await createRepo(testRepoName); + await PageObjects.snapshotRestore.navToPolicies(); + }); + it('page one', async () => { + await PageObjects.snapshotRestore.fillCreateNewPolicyPageOne( + 'testpolicy', + '' + ); + await a11y.testAppSnapshot(); + }); + it('page two', async () => { + await PageObjects.snapshotRestore.fillCreateNewPolicyPageTwo(); + await a11y.testAppSnapshot(); + }); + it('page three', async () => { + await PageObjects.snapshotRestore.fillCreateNewPolicyPageThree(); + await a11y.testAppSnapshot(); + }); + it('submit page four and flyout', async () => { + // Commenting out this snapshot as this is reported. https://github.com/elastic/kibana/issues/134514 + await PageObjects.snapshotRestore.submitNewPolicy(); + // await a11y.testAppSnapshot(); + }); + it('policy table with data', async () => { + await PageObjects.snapshotRestore.closeFlyout(); + await a11y.testAppSnapshot(); + }); + + after(async () => { + await es.snapshot.deleteRepository({ name: [testRepoName] }); + await es.slm.deleteLifecycle({ policy_id: 'testpolicy' }); + }); + }); + }); +} diff --git a/x-pack/test/accessibility/config.ts b/x-pack/test/accessibility/config.ts index 739ff5318bc10..e5e7cabcc4bae 100644 --- a/x-pack/test/accessibility/config.ts +++ b/x-pack/test/accessibility/config.ts @@ -19,6 +19,7 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { require.resolve('./apps/login_page'), require.resolve('./apps/kibana_overview'), require.resolve('./apps/home'), + require.resolve('./apps/management'), require.resolve('./apps/grok_debugger'), require.resolve('./apps/search_profiler'), require.resolve('./apps/painless_lab'), @@ -40,6 +41,7 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) { require.resolve('./apps/security_solution'), require.resolve('./apps/ml_embeddables_in_dashboard'), require.resolve('./apps/remote_clusters'), + require.resolve('./apps/snapshot_and_restore'), require.resolve('./apps/reporting'), require.resolve('./apps/enterprise_search'), require.resolve('./apps/license_management'), diff --git a/x-pack/test/api_integration/apis/ml/modules/get_module.ts b/x-pack/test/api_integration/apis/ml/modules/get_module.ts index 5810b4bf7e6c8..4ff71201d9ad9 100644 --- a/x-pack/test/api_integration/apis/ml/modules/get_module.ts +++ b/x-pack/test/api_integration/apis/ml/modules/get_module.ts @@ -7,7 +7,7 @@ import expect from '@kbn/expect'; -import { isPopulatedObject } from '@kbn/ml-plugin/common/util/object_utils'; +import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { USER } from '../../../../functional/services/ml/security_common'; import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; diff --git a/x-pack/test/api_integration/apis/monitoring/elasticsearch_settings/set_collection_enabled.js b/x-pack/test/api_integration/apis/monitoring/elasticsearch_settings/set_collection_enabled.js index ea94031c782c3..54c3eaa7f9049 100644 --- a/x-pack/test/api_integration/apis/monitoring/elasticsearch_settings/set_collection_enabled.js +++ b/x-pack/test/api_integration/apis/monitoring/elasticsearch_settings/set_collection_enabled.js @@ -28,7 +28,7 @@ export default function ({ getService }) { }; await esSupertest.put('/_cluster/settings').send(disableCollection).expect(200); - await esDeleteAllIndices('/.monitoring-*'); + await esDeleteAllIndices('.monitoring-*'); }); it('should set collection.enabled to true', async () => { diff --git a/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js b/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js index e5f242909be14..5d58316a83d95 100644 --- a/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js +++ b/x-pack/test/api_integration/apis/monitoring/logstash/node_detail_mb.js @@ -25,7 +25,7 @@ export default function ({ getService }) { }); after('unload archive', () => { - // return esArchiver.unload(archive); + return esArchiver.unload(archive); }); it('should summarize the Logstash node with non-advanced chart data metrics', async () => { diff --git a/x-pack/test/api_integration/apis/uptime/rest/add_monitor_project.ts b/x-pack/test/api_integration/apis/uptime/rest/add_monitor_project.ts index 512cb0c96056e..0445843ddd02e 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/add_monitor_project.ts +++ b/x-pack/test/api_integration/apis/uptime/rest/add_monitor_project.ts @@ -576,5 +576,58 @@ export default function ({ getService }: FtrProviderContext) { await security.role.delete(roleName); } }); + + it('project monitors - is able to decrypt monitor when updated after hydration', async () => { + try { + await supertest + .put(API_URLS.SYNTHETICS_MONITORS_PROJECT) + .set('kbn-xsrf', 'true') + .send(projectMonitors); + + const response = await supertest + .get(API_URLS.SYNTHETICS_MONITORS) + .query({ + filter: `${syntheticsMonitorType}.attributes.journey_id: ${projectMonitors.monitors[0].id}`, + }) + .set('kbn-xsrf', 'true') + .expect(200); + + const { monitors } = response.body; + + // add urls and ports to mimic hydration + const updates = { + [ConfigKey.URLS]: 'https://modified-host.com', + [ConfigKey.PORT]: 443, + }; + + const modifiedMonitor = { ...monitors[0]?.attributes, ...updates }; + + await supertest + .put(API_URLS.SYNTHETICS_MONITORS + '/' + monitors[0]?.id) + .set('kbn-xsrf', 'true') + .send(modifiedMonitor) + .expect(200); + + // update project monitor via push api + const apiResponse = await supertest + .put(API_URLS.SYNTHETICS_MONITORS_PROJECT) + .set('kbn-xsrf', 'true') + .send(projectMonitors) + .expect(200); + expect(apiResponse.body.updatedMonitors).eql([projectMonitors.monitors[0].id]); + + // ensure that monitor can still be decrypted + await supertest + .get(API_URLS.SYNTHETICS_MONITORS + '/' + monitors[0]?.id) + .set('kbn-xsrf', 'true') + .expect(200); + } finally { + await Promise.all([ + projectMonitors.monitors.map((monitor) => { + return deleteMonitor(monitor.id, projectMonitors.project); + }), + ]); + } + }); }); } diff --git a/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json b/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json index 5cc0d2bca4179..ae3c9d017362e 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json +++ b/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json @@ -43,5 +43,7 @@ "locations": [], "name": "Test HTTP Monitor 03", "namespace": "testnamespace", - "origin": "ui" + "origin": "ui", + "urls": null, + "url.port": null } diff --git a/x-pack/test/apm_api_integration/common/authentication.ts b/x-pack/test/apm_api_integration/common/authentication.ts index 288f483c8c005..28dffac7f80ca 100644 --- a/x-pack/test/apm_api_integration/common/authentication.ts +++ b/x-pack/test/apm_api_integration/common/authentication.ts @@ -7,25 +7,33 @@ import { Client } from '@elastic/elasticsearch'; import { PrivilegeType } from '@kbn/apm-plugin/common/privilege_type'; +import { ToolingLog } from '@kbn/tooling-log'; +import { omit } from 'lodash'; +import { KbnClientRequesterError } from '@kbn/test'; +import { AxiosError } from 'axios'; import { SecurityServiceProvider } from '../../../../test/common/services/security'; type SecurityService = Awaited>; -export enum ApmUser { +export enum ApmUsername { noAccessUser = 'no_access_user', - viewerUser = 'viewer_user', - editorUser = 'editor_user', + viewerUser = 'viewer', + editorUser = 'editor', apmAnnotationsWriteUser = 'apm_annotations_write_user', apmReadUserWithoutMlAccess = 'apm_read_user_without_ml_access', apmManageOwnAgentKeys = 'apm_manage_own_agent_keys', apmManageOwnAndCreateAgentKeys = 'apm_manage_own_and_create_agent_keys', } -const roles = { - [ApmUser.noAccessUser]: {}, - [ApmUser.viewerUser]: {}, - [ApmUser.editorUser]: {}, - [ApmUser.apmReadUserWithoutMlAccess]: { +export enum ApmCustomRolename { + apmReadUserWithoutMlAccess = 'apm_read_user_without_ml_access', + apmAnnotationsWriteUser = 'apm_annotations_write_user', + apmManageOwnAgentKeys = 'apm_manage_own_agent_keys', + apmManageOwnAndCreateAgentKeys = 'apm_manage_own_and_create_agent_keys', +} + +const customRoles = { + [ApmCustomRolename.apmReadUserWithoutMlAccess]: { elasticsearch: { cluster: [], indices: [ @@ -43,7 +51,7 @@ const roles = { }, ], }, - [ApmUser.apmAnnotationsWriteUser]: { + [ApmCustomRolename.apmAnnotationsWriteUser]: { elasticsearch: { cluster: [], indices: [ @@ -61,12 +69,12 @@ const roles = { ], }, }, - [ApmUser.apmManageOwnAgentKeys]: { + [ApmCustomRolename.apmManageOwnAgentKeys]: { elasticsearch: { cluster: ['manage_own_api_key'], }, }, - [ApmUser.apmManageOwnAndCreateAgentKeys]: { + [ApmCustomRolename.apmManageOwnAndCreateAgentKeys]: { applications: [ { application: 'apm', @@ -77,55 +85,101 @@ const roles = { }, }; -const users = { - [ApmUser.noAccessUser]: { - roles: [], - }, - [ApmUser.viewerUser]: { - roles: ['viewer'], +const users: Record< + ApmUsername, + { builtInRoleNames?: string[]; customRoleNames?: ApmCustomRolename[] } +> = { + [ApmUsername.noAccessUser]: {}, + [ApmUsername.viewerUser]: { + builtInRoleNames: ['viewer'], }, - [ApmUser.editorUser]: { - roles: ['editor'], + [ApmUsername.editorUser]: { + builtInRoleNames: ['editor'], }, - [ApmUser.apmReadUserWithoutMlAccess]: { - roles: [ApmUser.apmReadUserWithoutMlAccess], + [ApmUsername.apmReadUserWithoutMlAccess]: { + customRoleNames: [ApmCustomRolename.apmReadUserWithoutMlAccess], }, - [ApmUser.apmAnnotationsWriteUser]: { - roles: ['editor', ApmUser.apmAnnotationsWriteUser], + [ApmUsername.apmAnnotationsWriteUser]: { + builtInRoleNames: ['editor'], + customRoleNames: [ApmCustomRolename.apmAnnotationsWriteUser], }, - [ApmUser.apmManageOwnAgentKeys]: { - roles: ['editor', ApmUser.apmManageOwnAgentKeys], + [ApmUsername.apmManageOwnAgentKeys]: { + builtInRoleNames: ['editor'], + customRoleNames: [ApmCustomRolename.apmManageOwnAgentKeys], }, - [ApmUser.apmManageOwnAndCreateAgentKeys]: { - roles: ['editor', ApmUser.apmManageOwnAgentKeys, ApmUser.apmManageOwnAndCreateAgentKeys], + [ApmUsername.apmManageOwnAndCreateAgentKeys]: { + builtInRoleNames: ['editor'], + customRoleNames: [ + ApmCustomRolename.apmManageOwnAgentKeys, + ApmCustomRolename.apmManageOwnAndCreateAgentKeys, + ], }, }; -export async function createApmUser(security: SecurityService, apmUser: ApmUser, es: Client) { - const role = roles[apmUser]; - const user = users[apmUser]; +function logErrorResponse(logger: ToolingLog, e: Error) { + if (e instanceof KbnClientRequesterError) { + logger.error(`KbnClientRequesterError: ${JSON.stringify(e.axiosError?.response?.data)}`); + } else if (e instanceof AxiosError) { + logger.error(`AxiosError: ${JSON.stringify(e.response?.data)}`); + } else { + logger.error(`Unknown error: ${e.constructor.name}`); + } +} + +export async function createApmUser({ + username, + security, + es, + logger, +}: { + username: ApmUsername; + security: SecurityService; + es: Client; + logger: ToolingLog; +}) { + const user = users[username]; - if (!role || !user) { - throw new Error(`No configuration found for ${apmUser}`); + if (!user) { + throw new Error(`No configuration found for ${username}`); } - if ('applications' in role) { - // Add application privileges with es client as they are not supported by - // security.user.create. They are preserved when updating the role below - await es.security.putRole({ - name: apmUser, - body: role, + const { builtInRoleNames = [], customRoleNames = [] } = user; + + try { + // create custom roles + await Promise.all( + customRoleNames.map(async (roleName) => createCustomRole({ roleName, security, es })) + ); + + // create user + await security.user.create(username, { + full_name: username, + password: APM_TEST_PASSWORD, + roles: [...builtInRoleNames, ...customRoleNames], }); - delete (role as any).applications; + } catch (e) { + logErrorResponse(logger, e); + throw e; } +} - await security.role.create(apmUser, role); +async function createCustomRole({ + roleName, + security, + es, +}: { + roleName: ApmCustomRolename; + security: SecurityService; + es: Client; +}) { + const role = customRoles[roleName]; - await security.user.create(apmUser, { - full_name: apmUser, - password: APM_TEST_PASSWORD, - roles: user.roles, - }); + // Add application privileges with es client as they are not supported by + // security.user.create. They are preserved when updating the role below + if ('applications' in role) { + await es.security.putRole({ name: roleName, body: role }); + } + await security.role.create(roleName, omit(role, 'applications')); } export const APM_TEST_PASSWORD = 'changeme'; diff --git a/x-pack/test/apm_api_integration/common/config.ts b/x-pack/test/apm_api_integration/common/config.ts index 4b56ad52c2e3f..3c9e99d645c7b 100644 --- a/x-pack/test/apm_api_integration/common/config.ts +++ b/x-pack/test/apm_api_integration/common/config.ts @@ -9,9 +9,10 @@ import { FtrConfigProviderContext } from '@kbn/test'; import supertest from 'supertest'; import { format, UrlObject } from 'url'; import { Client } from '@elastic/elasticsearch'; +import { ToolingLog } from '@kbn/tooling-log'; import { SecurityServiceProvider } from '../../../../test/common/services/security'; import { InheritedFtrProviderContext, InheritedServices } from './ftr_provider_context'; -import { createApmUser, APM_TEST_PASSWORD, ApmUser } from './authentication'; +import { createApmUser, APM_TEST_PASSWORD, ApmUsername } from './authentication'; import { APMFtrConfigName } from '../configs'; import { createApmApiClient } from './apm_api_supertest'; import { RegistryProvider } from './registry'; @@ -26,34 +27,42 @@ export interface ApmFtrConfig { type SecurityService = Awaited>; -function getLegacySupertestClient(kibanaServer: UrlObject, apmUser: ApmUser) { +function getLegacySupertestClient(kibanaServer: UrlObject, username: ApmUsername) { return async (context: InheritedFtrProviderContext) => { const security = context.getService('security'); const es = context.getService('es'); + const logger = context.getService('log'); await security.init(); - await createApmUser(security, apmUser, es); + await createApmUser({ security, username, es, logger }); const url = format({ ...kibanaServer, - auth: `${apmUser}:${APM_TEST_PASSWORD}`, + auth: `${username}:${APM_TEST_PASSWORD}`, }); return supertest(url); }; } -async function getApmApiClient( - kibanaServer: UrlObject, - security: SecurityService, - apmUser: ApmUser, - es: Client -) { - await createApmUser(security, apmUser, es); +async function getApmApiClient({ + kibanaServer, + security, + username, + es, + logger, +}: { + kibanaServer: UrlObject; + security: SecurityService; + username: ApmUsername; + es: Client; + logger: ToolingLog; +}) { + await createApmUser({ security, username, es, logger }); const url = format({ ...kibanaServer, - auth: `${apmUser}:${APM_TEST_PASSWORD}`, + auth: `${username}:${APM_TEST_PASSWORD}`, }); return createApmApiClient(supertest(url)); @@ -85,50 +94,83 @@ export function createTestConfig(config: ApmFtrConfig) { apmApiClient: async (context: InheritedFtrProviderContext) => { const security = context.getService('security'); const es = context.getService('es'); + const logger = context.getService('log'); + await security.init(); return { - noAccessUser: await getApmApiClient(servers.kibana, security, ApmUser.noAccessUser, es), - readUser: await getApmApiClient(servers.kibana, security, ApmUser.viewerUser, es), - writeUser: await getApmApiClient(servers.kibana, security, ApmUser.editorUser, es), - annotationWriterUser: await getApmApiClient( - servers.kibana, + noAccessUser: await getApmApiClient({ + kibanaServer: servers.kibana, + security, + username: ApmUsername.noAccessUser, + es, + logger, + }), + readUser: await getApmApiClient({ + kibanaServer: servers.kibana, + security, + username: ApmUsername.viewerUser, + es, + logger, + }), + writeUser: await getApmApiClient({ + kibanaServer: servers.kibana, security, - ApmUser.apmAnnotationsWriteUser, - es - ), - noMlAccessUser: await getApmApiClient( - servers.kibana, + username: ApmUsername.editorUser, + es, + logger, + }), + annotationWriterUser: await getApmApiClient({ + kibanaServer: servers.kibana, security, - ApmUser.apmReadUserWithoutMlAccess, - es - ), - manageOwnAgentKeysUser: await getApmApiClient( - servers.kibana, + username: ApmUsername.apmAnnotationsWriteUser, + es, + logger, + }), + noMlAccessUser: await getApmApiClient({ + kibanaServer: servers.kibana, security, - ApmUser.apmManageOwnAgentKeys, - es - ), - createAndAllAgentKeysUser: await getApmApiClient( - servers.kibana, + username: ApmUsername.apmReadUserWithoutMlAccess, + es, + logger, + }), + manageOwnAgentKeysUser: await getApmApiClient({ + kibanaServer: servers.kibana, security, - ApmUser.apmManageOwnAndCreateAgentKeys, - es - ), + username: ApmUsername.apmManageOwnAgentKeys, + es, + logger, + }), + createAndAllAgentKeysUser: await getApmApiClient({ + kibanaServer: servers.kibana, + security, + username: ApmUsername.apmManageOwnAndCreateAgentKeys, + es, + logger, + }), }; }, ml: MachineLearningAPIProvider, // legacy clients - legacySupertestAsNoAccessUser: getLegacySupertestClient(kibanaServer, ApmUser.noAccessUser), - legacySupertestAsApmReadUser: getLegacySupertestClient(kibanaServer, ApmUser.viewerUser), - legacySupertestAsApmWriteUser: getLegacySupertestClient(kibanaServer, ApmUser.editorUser), + legacySupertestAsNoAccessUser: getLegacySupertestClient( + kibanaServer, + ApmUsername.noAccessUser + ), + legacySupertestAsApmReadUser: getLegacySupertestClient( + kibanaServer, + ApmUsername.viewerUser + ), + legacySupertestAsApmWriteUser: getLegacySupertestClient( + kibanaServer, + ApmUsername.editorUser + ), legacySupertestAsApmAnnotationsWriteUser: getLegacySupertestClient( kibanaServer, - ApmUser.apmAnnotationsWriteUser + ApmUsername.apmAnnotationsWriteUser ), legacySupertestAsApmReadUserWithoutMlAccess: getLegacySupertestClient( kibanaServer, - ApmUser.apmReadUserWithoutMlAccess + ApmUsername.apmReadUserWithoutMlAccess ), }, junit: { diff --git a/x-pack/test/apm_api_integration/tests/settings/agent_keys/agent_keys.spec.ts b/x-pack/test/apm_api_integration/tests/settings/agent_keys/agent_keys.spec.ts index 4a32ef4a023a6..2f607cecb75bb 100644 --- a/x-pack/test/apm_api_integration/tests/settings/agent_keys/agent_keys.spec.ts +++ b/x-pack/test/apm_api_integration/tests/settings/agent_keys/agent_keys.spec.ts @@ -9,7 +9,7 @@ import { first } from 'lodash'; import { PrivilegeType } from '@kbn/apm-plugin/common/privilege_type'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; import { ApmApiError, ApmApiSupertest } from '../../../common/apm_api_supertest'; -import { ApmUser } from '../../../common/authentication'; +import { ApmUsername } from '../../../common/authentication'; export default function ApiTest({ getService }: FtrProviderContext) { const registry = getService('registry'); @@ -92,7 +92,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { () => { afterEach(async () => { await esClient.security.invalidateApiKey({ - username: ApmUser.apmManageOwnAndCreateAgentKeys, + username: ApmUsername.apmManageOwnAndCreateAgentKeys, }); }); diff --git a/x-pack/test/fleet_api_integration/apis/package_policy/get.ts b/x-pack/test/fleet_api_integration/apis/package_policy/get.ts index 1e90ab76666fe..5c3ed257d7b5e 100644 --- a/x-pack/test/fleet_api_integration/apis/package_policy/get.ts +++ b/x-pack/test/fleet_api_integration/apis/package_policy/get.ts @@ -5,6 +5,7 @@ * 2.0. */ +import expect from '@kbn/expect'; import { FtrProviderContext } from '../../../api_integration/ftr_provider_context'; import { skipIfNoDockerRegistry } from '../../helpers'; @@ -18,10 +19,9 @@ export default function (providerContext: FtrProviderContext) { // because `this` has to point to the Mocha context // see https://mochajs.org/#arrow-functions - describe('Package Policy - get by id', async function () { + describe('Package Policy APIs', () => { skipIfNoDockerRegistry(providerContext); - let agentPolicyId: string; - let packagePolicyId: string; + before(async () => { await getService('esArchiver').load('x-pack/test/functional/es_archives/empty_kibana'); await getService('esArchiver').load( @@ -29,68 +29,146 @@ export default function (providerContext: FtrProviderContext) { ); }); - before(async function () { - if (!server.enabled) { - return; - } - const { body: agentPolicyResponse } = await supertest - .post(`/api/fleet/agent_policies`) - .set('kbn-xsrf', 'xxxx') - .send({ - name: 'Test policy', - namespace: 'default', - }); - agentPolicyId = agentPolicyResponse.item.id; - - const { body: packagePolicyResponse } = await supertest - .post(`/api/fleet/package_policies`) - .set('kbn-xsrf', 'xxxx') - .send({ - name: 'filetest-1', - description: '', - namespace: 'default', - policy_id: agentPolicyId, - enabled: true, - output_id: '', - inputs: [], - package: { - name: 'filetest', - title: 'For File Tests', - version: '0.1.0', - }, - }); - packagePolicyId = packagePolicyResponse.item.id; - }); - - after(async function () { - if (!server.enabled) { - return; - } - - await supertest - .post(`/api/fleet/agent_policies/delete`) - .set('kbn-xsrf', 'xxxx') - .send({ agentPolicyId }) - .expect(200); - - await supertest - .post(`/api/fleet/package_policies/delete`) - .set('kbn-xsrf', 'xxxx') - .send({ packagePolicyIds: [packagePolicyId] }) - .expect(200); - }); after(async () => { await getService('esArchiver').unload( 'x-pack/test/functional/es_archives/fleet/empty_fleet_server' ); await getService('esArchiver').unload('x-pack/test/functional/es_archives/empty_kibana'); }); - it('should succeed with a valid id', async function () { - await supertest.get(`/api/fleet/package_policies/${packagePolicyId}`).expect(200); + + describe('get by id', async function () { + let agentPolicyId: string; + let packagePolicyId: string; + + before(async function () { + if (!server.enabled) { + return; + } + + const { body: agentPolicyResponse } = await supertest + .post(`/api/fleet/agent_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'Test policy', + namespace: 'default', + }); + agentPolicyId = agentPolicyResponse.item.id; + + const { body: packagePolicyResponse } = await supertest + .post(`/api/fleet/package_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'filetest-1', + description: '', + namespace: 'default', + policy_id: agentPolicyId, + enabled: true, + output_id: '', + inputs: [], + package: { + name: 'filetest', + title: 'For File Tests', + version: '0.1.0', + }, + }); + packagePolicyId = packagePolicyResponse.item.id; + }); + + after(async function () { + if (!server.enabled) { + return; + } + + await supertest + .post(`/api/fleet/agent_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ agentPolicyId }) + .expect(200); + + await supertest + .post(`/api/fleet/package_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ packagePolicyIds: [packagePolicyId] }) + .expect(200); + }); + + it('should succeed with a valid id', async function () { + await supertest.get(`/api/fleet/package_policies/${packagePolicyId}`).expect(200); + }); + + it('should return a 404 with an invalid id', async function () { + await supertest.get(`/api/fleet/package_policies/IS_NOT_PRESENT`).expect(404); + }); }); - it('should return a 404 with an invalid id', async function () { - await supertest.get(`/api/fleet/package_policies/IS_NOT_PRESENT`).expect(404); + describe('get orphaned policies', () => { + let agentPolicyId: string; + let packagePolicyId: string; + + before(async function () { + if (!server.enabled) { + return; + } + + const { body: agentPolicyResponse } = await supertest + .post(`/api/fleet/agent_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'Test policy', + namespace: 'default', + }); + + agentPolicyId = agentPolicyResponse.item.id; + + const { body: packagePolicyResponse } = await supertest + .post(`/api/fleet/package_policies`) + .set('kbn-xsrf', 'xxxx') + .send({ + name: 'filetest-1', + description: '', + namespace: 'default', + policy_id: agentPolicyId, + enabled: true, + output_id: '', + inputs: [], + package: { + name: 'filetest', + title: 'For File Tests', + version: '0.1.0', + }, + }); + + packagePolicyId = packagePolicyResponse.item.id; + + // Delete the agent policy directly from ES to orphan the package policy + const esClient = getService('es'); + await esClient.delete({ + index: '.kibana', + id: `ingest-agent-policies:${agentPolicyId}`, + refresh: 'wait_for', + }); + }); + + after(async function () { + if (!server.enabled) { + return; + } + + await supertest + .post(`/api/fleet/package_policies/delete`) + .set('kbn-xsrf', 'xxxx') + .send({ packagePolicyIds: [packagePolicyId], force: true }) + .expect(200); + }); + + it('should return orphaned policy', async () => { + const response = await supertest + .get('/internal/fleet/orphaned_integration_policies') + .expect(200); + + expect(response.body.items).to.have.length(1); + expect(response.body.items[0].id).to.eql(packagePolicyId); + }); }); }); } diff --git a/x-pack/test/functional/apps/dashboard/group3/drilldowns/index.ts b/x-pack/test/functional/apps/dashboard/group3/drilldowns/index.ts index eaa1189ab1007..a8af67665e845 100644 --- a/x-pack/test/functional/apps/dashboard/group3/drilldowns/index.ts +++ b/x-pack/test/functional/apps/dashboard/group3/drilldowns/index.ts @@ -16,12 +16,15 @@ export default function ({ loadTestFile, getService }: FtrProviderContext) { before(async () => { await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); - await esArchiver.load('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns' + ); await kibanaServer.uiSettings.replace({ defaultIndex: 'logstash-*' }); }); after(async () => { - await esArchiver.unload('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); }); loadTestFile(require.resolve('./dashboard_to_dashboard_drilldown')); diff --git a/x-pack/test/functional/apps/discover/value_suggestions.ts b/x-pack/test/functional/apps/discover/value_suggestions.ts index 5afd3d53ca85b..3151f729aa58c 100644 --- a/x-pack/test/functional/apps/discover/value_suggestions.ts +++ b/x-pack/test/functional/apps/discover/value_suggestions.ts @@ -13,7 +13,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const esArchiver = getService('esArchiver'); const queryBar = getService('queryBar'); const filterBar = getService('filterBar'); - const docTable = getService('docTable'); + const dataGrid = getService('dataGrid'); const PageObjects = getPageObjects(['common', 'timePicker', 'settings', 'context']); async function setAutocompleteUseTimeRange(value: boolean) { @@ -27,16 +27,20 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('value suggestions', function describeIndexTests() { before(async function () { + await kibanaServer.savedObjects.cleanStandardList(); await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); - await esArchiver.load('x-pack/test/functional/es_archives/dashboard/drilldowns'); + + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns' + ); await kibanaServer.uiSettings.update({ - 'doc_table:legacy': true, + 'doc_table:legacy': false, }); }); after(async () => { - await esArchiver.unload('x-pack/test/functional/es_archives/dashboard/drilldowns'); await kibanaServer.uiSettings.unset('doc_table:legacy'); + await kibanaServer.savedObjects.cleanStandardList(); }); describe('useTimeRange enabled', () => { @@ -86,9 +90,9 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.timePicker.setDefaultAbsoluteRange(); // navigate to context - await docTable.clickRowToggle({ rowIndex: 0 }); - const rowActions = await docTable.getRowActions({ rowIndex: 0 }); - await rowActions[0].click(); + await dataGrid.clickRowToggle({ rowIndex: 0 }); + const rowActions = await dataGrid.getRowActions({ rowIndex: 0 }); + await rowActions[1].click(); await PageObjects.context.waitUntilContextLoadingHasFinished(); // Apply filter in context view diff --git a/x-pack/test/functional/apps/discover/value_suggestions_non_timebased.ts b/x-pack/test/functional/apps/discover/value_suggestions_non_timebased.ts index 8d95d85a88e1e..7d8f8a302b05c 100644 --- a/x-pack/test/functional/apps/discover/value_suggestions_non_timebased.ts +++ b/x-pack/test/functional/apps/discover/value_suggestions_non_timebased.ts @@ -24,7 +24,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { ); await kibanaServer.uiSettings.replace({ defaultIndex: 'without-timefield' }); await kibanaServer.uiSettings.update({ - 'doc_table:legacy': true, + 'doc_table:legacy': false, }); }); diff --git a/x-pack/test/functional/apps/lens/group1/smokescreen.ts b/x-pack/test/functional/apps/lens/group1/smokescreen.ts index 70887b337114f..2f82218b42a7a 100644 --- a/x-pack/test/functional/apps/lens/group1/smokescreen.ts +++ b/x-pack/test/functional/apps/lens/group1/smokescreen.ts @@ -125,23 +125,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(await PageObjects.lens.hasChartSwitchWarning('line')).to.eql(false); await PageObjects.lens.switchToVisualization('line'); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_xDimensionPanel > lns-empty-dimension', - operation: 'terms', - field: 'geo.src', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_xDimensionPanel > lns-empty-dimension', + operation: 'terms', + field: 'geo.src', + }); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_yDimensionPanel > lns-empty-dimension', - operation: 'median', - field: 'bytes', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-empty-dimension', + operation: 'median', + field: 'bytes', + }); expect(await PageObjects.lens.getLayerCount()).to.eql(2); await PageObjects.lens.removeLayer(); @@ -308,23 +302,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.createLayer(); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_xDimensionPanel > lns-empty-dimension', - operation: 'terms', - field: 'geo.src', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_xDimensionPanel > lns-empty-dimension', + operation: 'terms', + field: 'geo.src', + }); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_yDimensionPanel > lns-empty-dimension', - operation: 'average', - field: 'bytes', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-empty-dimension', + operation: 'average', + field: 'bytes', + }); await PageObjects.lens.save('twolayerchart'); await testSubjects.click('lnsSuggestion-asDonut > lnsSuggestion'); diff --git a/x-pack/test/functional/apps/lens/group1/table.ts b/x-pack/test/functional/apps/lens/group1/table.ts index 18ecc2e90cfe4..7bf9b49c53d8d 100644 --- a/x-pack/test/functional/apps/lens/group1/table.ts +++ b/x-pack/test/functional/apps/lens/group1/table.ts @@ -73,10 +73,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('should allow to transpose columns', async () => { - await PageObjects.lens.dragDimensionToDimension( - 'lnsDatatable_rows > lns-dimensionTrigger', - 'lnsDatatable_columns > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsDatatable_rows > lns-dimensionTrigger', + to: 'lnsDatatable_columns > lns-empty-dimension', + }); expect(await PageObjects.lens.getDatatableHeaderText(0)).to.equal('@timestamp per 3 hours'); expect(await PageObjects.lens.getDatatableHeaderText(1)).to.equal( '169.228.188.120 › Average of bytes' diff --git a/x-pack/test/functional/apps/lens/group2/dashboard.ts b/x-pack/test/functional/apps/lens/group2/dashboard.ts index 787a0a6a6d99a..a6f315deba86d 100644 --- a/x-pack/test/functional/apps/lens/group2/dashboard.ts +++ b/x-pack/test/functional/apps/lens/group2/dashboard.ts @@ -183,23 +183,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(await PageObjects.lens.hasChartSwitchWarning('line')).to.eql(false); await PageObjects.lens.switchToVisualization('line'); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_xDimensionPanel > lns-empty-dimension', - operation: 'date_histogram', - field: '@timestamp', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_xDimensionPanel > lns-empty-dimension', + operation: 'date_histogram', + field: '@timestamp', + }); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_yDimensionPanel > lns-empty-dimension', - operation: 'median', - field: 'bytes', - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-empty-dimension', + operation: 'median', + field: 'bytes', + }); await PageObjects.lens.saveAndReturn(); await panelActions.openContextMenu(); diff --git a/x-pack/test/functional/apps/lens/group3/annotations.ts b/x-pack/test/functional/apps/lens/group3/annotations.ts index 2b641c6c161d4..62e5edb564871 100644 --- a/x-pack/test/functional/apps/lens/group3/annotations.ts +++ b/x-pack/test/functional/apps/lens/group3/annotations.ts @@ -51,10 +51,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should duplicate the style when duplicating an annotation and group them in the chart', async () => { // drag and drop to the empty field to generate a duplicate - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_xAnnotationsPanel > lns-dimensionTrigger', - 'lnsXY_xAnnotationsPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_xAnnotationsPanel > lns-dimensionTrigger', + to: 'lnsXY_xAnnotationsPanel > lns-empty-dimension', + }); await ( await find.byCssSelector( diff --git a/x-pack/test/functional/apps/lens/group3/drag_and_drop.ts b/x-pack/test/functional/apps/lens/group3/drag_and_drop.ts index dec72008d6f04..626527a9c35cf 100644 --- a/x-pack/test/functional/apps/lens/group3/drag_and_drop.ts +++ b/x-pack/test/functional/apps/lens/group3/drag_and_drop.ts @@ -8,8 +8,10 @@ import expect from '@kbn/expect'; import { FtrProviderContext } from '../../../ftr_provider_context'; -export default function ({ getPageObjects }: FtrProviderContext) { +export default function ({ getService, getPageObjects }: FtrProviderContext) { const PageObjects = getPageObjects(['visualize', 'lens', 'common', 'header']); + + const listingTable = getService('listingTable'); const xyChartContainer = 'xyVisChart'; describe('lens drag and drop tests', () => { @@ -72,10 +74,10 @@ export default function ({ getPageObjects }: FtrProviderContext) { await PageObjects.lens.getDimensionTriggersTexts('lnsXY_splitDimensionPanel') ).to.eql(['Top 3 values of clientip']); - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_xDimensionPanel > lns-dimensionTrigger', - 'lnsXY_splitDimensionPanel > lns-dimensionTrigger' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lns-layerPanel-0 > lnsXY_xDimensionPanel > lns-dimensionTrigger', + to: 'lns-layerPanel-0 > lnsXY_splitDimensionPanel > lns-dimensionTrigger', + }); expect(await PageObjects.lens.getDimensionTriggersTexts('lnsXY_xDimensionPanel')).to.eql( [] @@ -90,10 +92,10 @@ export default function ({ getPageObjects }: FtrProviderContext) { await PageObjects.lens.getDimensionTriggersTexts('lnsXY_splitDimensionPanel') ).to.eql(['Top 3 values of @message.raw']); - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_splitDimensionPanel > lns-dimensionTrigger', - 'lnsXY_yDimensionPanel > lns-dimensionTrigger' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_splitDimensionPanel > lns-dimensionTrigger', + to: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + }); expect( await PageObjects.lens.getDimensionTriggersTexts('lnsXY_splitDimensionPanel') @@ -106,14 +108,14 @@ export default function ({ getPageObjects }: FtrProviderContext) { ]); }); it('should duplicate the column when dragging to empty dimension in the same group', async () => { - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yDimensionPanel > lns-dimensionTrigger', - 'lnsXY_yDimensionPanel > lns-empty-dimension' - ); - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yDimensionPanel > lns-dimensionTrigger', - 'lnsXY_yDimensionPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + to: 'lnsXY_yDimensionPanel > lns-empty-dimension', + }); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + to: 'lnsXY_yDimensionPanel > lns-empty-dimension', + }); expect(await PageObjects.lens.getDimensionTriggersTexts('lnsXY_yDimensionPanel')).to.eql([ 'Unique count of @message.raw', 'Unique count of @message.raw [1]', @@ -121,10 +123,10 @@ export default function ({ getPageObjects }: FtrProviderContext) { ]); }); it('should move duplicated column to non-compatible dimension group', async () => { - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yDimensionPanel > lns-dimensionTrigger', - 'lnsXY_xDimensionPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + to: 'lnsXY_xDimensionPanel > lns-empty-dimension', + }); expect(await PageObjects.lens.getDimensionTriggersTexts('lnsXY_yDimensionPanel')).to.eql([ 'Unique count of @message.raw', 'Unique count of @message.raw [1]', @@ -340,5 +342,132 @@ export default function ({ getPageObjects }: FtrProviderContext) { ]); }); }); + + describe('dropping between layers', () => { + it('should move the column', async () => { + await PageObjects.visualize.gotoVisualizationLandingPage(); + await listingTable.searchForItemWithName('lnsXYvis'); + await PageObjects.lens.clickVisualizeListItemTitle('lnsXYvis'); + await PageObjects.lens.goToTimeRange(); + + await PageObjects.lens.createLayer('data'); + + await PageObjects.lens.dragDimensionToExtraDropType( + 'lns-layerPanel-0 > lnsXY_xDimensionPanel > lns-dimensionTrigger', + 'lns-layerPanel-1 > lnsXY_xDimensionPanel', + 'duplicate' + ); + + await PageObjects.lens.assertFocusedDimension('@timestamp [1]'); + + await PageObjects.lens.dragDimensionToExtraDropType( + 'lns-layerPanel-0 > lnsXY_yDimensionPanel > lns-dimensionTrigger', + 'lns-layerPanel-1 > lnsXY_yDimensionPanel', + 'duplicate' + ); + + await PageObjects.lens.assertFocusedDimension('Average of bytes [1]'); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-0')).to.eql([ + '@timestamp', + 'Average of bytes', + 'Top values of ip', + ]); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-1')).to.eql([ + '@timestamp [1]', + 'Average of bytes [1]', + ]); + }); + + it('should move formula to empty dimension', async () => { + await PageObjects.lens.configureDimension({ + dimension: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + operation: 'formula', + formula: `moving_average(average(bytes), window=5`, + }); + await PageObjects.lens.dragDimensionToExtraDropType( + 'lns-layerPanel-0 > lnsXY_yDimensionPanel > lns-dimensionTrigger', + 'lns-layerPanel-1 > lnsXY_yDimensionPanel', + 'duplicate' + ); + + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-0')).to.eql([ + '@timestamp', + 'moving_average(average(bytes), window=5)', + 'Top 3 values of ip', + ]); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-1')).to.eql([ + '@timestamp [1]', + 'moving_average(average(bytes), window=5) [1]', + ]); + }); + + it('should replace formula with another formula', async () => { + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-dimensionTrigger', + operation: 'formula', + formula: `sum(bytes) + 5`, + }); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lns-layerPanel-0 > lnsXY_yDimensionPanel > lns-dimensionTrigger', + to: 'lns-layerPanel-1 > lnsXY_yDimensionPanel > lns-dimensionTrigger', + }); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-0')).to.eql([ + '@timestamp', + 'Top 3 values of ip', + ]); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-1')).to.eql([ + '@timestamp [1]', + 'moving_average(average(bytes), window=5)', + ]); + }); + it('swaps dimensions', async () => { + await PageObjects.visualize.gotoVisualizationLandingPage(); + await listingTable.searchForItemWithName('lnsXYvis'); + await PageObjects.lens.clickVisualizeListItemTitle('lnsXYvis'); + await PageObjects.lens.goToTimeRange(); + + await PageObjects.lens.createLayer('data'); + await PageObjects.lens.dragFieldToDimensionTrigger( + 'bytes', + 'lns-layerPanel-0 > lnsXY_yDimensionPanel > lns-empty-dimension' + ); + await PageObjects.lens.dragFieldToDimensionTrigger( + 'bytes', + 'lns-layerPanel-1 > lnsXY_splitDimensionPanel > lns-empty-dimension' + ); + + await PageObjects.lens.dragDimensionToExtraDropType( + 'lns-layerPanel-1 > lnsXY_splitDimensionPanel > lns-dimensionTrigger', + 'lns-layerPanel-0 > lnsXY_splitDimensionPanel', + 'swap' + ); + + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-0')).to.eql([ + '@timestamp', + 'Average of bytes', + 'Median of bytes', + 'bytes', + ]); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-1')).to.eql([ + 'Top 3 values of ip', + ]); + }); + it('can combine dimensions', async () => { + await PageObjects.lens.dragDimensionToExtraDropType( + 'lns-layerPanel-0 > lnsXY_splitDimensionPanel > lns-dimensionTrigger', + 'lns-layerPanel-1 > lnsXY_splitDimensionPanel', + 'combine' + ); + + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-0')).to.eql([ + '@timestamp', + 'Average of bytes', + 'Median of bytes', + ]); + expect(await PageObjects.lens.getDimensionTriggersTexts('lns-layerPanel-1')).to.eql([ + 'Top values of ip + 1 other', + ]); + }); + }); }); } diff --git a/x-pack/test/functional/apps/lens/group3/error_handling.ts b/x-pack/test/functional/apps/lens/group3/error_handling.ts index 8f6659bda1562..794547fb96f05 100644 --- a/x-pack/test/functional/apps/lens/group3/error_handling.ts +++ b/x-pack/test/functional/apps/lens/group3/error_handling.ts @@ -56,10 +56,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.waitForMissingDataViewWarning(); await PageObjects.lens.openDimensionEditor('lnsXY_yDimensionPanel > lns-dimensionTrigger'); await PageObjects.lens.closeDimensionEditor(); - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yDimensionPanel > lns-dimensionTrigger', - 'lnsXY_yDimensionPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yDimensionPanel > lns-dimensionTrigger', + to: 'lnsXY_yDimensionPanel > lns-empty-dimension', + }); await PageObjects.lens.switchFirstLayerIndexPattern('log*'); await PageObjects.lens.waitForMissingDataViewWarningDisappear(); await PageObjects.lens.waitForEmptyWorkspace(); diff --git a/x-pack/test/functional/apps/lens/group3/formula.ts b/x-pack/test/functional/apps/lens/group3/formula.ts index 33a24d3aefb1c..806e892cec643 100644 --- a/x-pack/test/functional/apps/lens/group3/formula.ts +++ b/x-pack/test/functional/apps/lens/group3/formula.ts @@ -205,10 +205,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.closeDimensionEditor(); - await PageObjects.lens.dragDimensionToDimension( - 'lnsDatatable_metrics > lns-dimensionTrigger', - 'lnsDatatable_metrics > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsDatatable_metrics > lns-dimensionTrigger', + to: 'lnsDatatable_metrics > lns-empty-dimension', + }); expect(await PageObjects.lens.getDatatableCellText(1, 1)).to.eql('222,420'); expect(await PageObjects.lens.getDatatableCellText(1, 2)).to.eql('222,420'); }); @@ -249,15 +249,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.createLayer('referenceLine'); - await PageObjects.lens.configureDimension( - { - dimension: 'lnsXY_yReferenceLineLeftPanel > lns-dimensionTrigger', - operation: 'formula', - formula: `count()`, - keepOpen: true, - }, - 1 - ); + await PageObjects.lens.configureDimension({ + dimension: 'lns-layerPanel-1 > lnsXY_yReferenceLineLeftPanel > lns-dimensionTrigger', + operation: 'formula', + formula: `count()`, + keepOpen: true, + }); await PageObjects.lens.switchToStaticValue(); await PageObjects.lens.closeDimensionEditor(); @@ -280,10 +277,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { formula: `0`, }); - await PageObjects.lens.dragDimensionToDimension( - 'lnsDatatable_metrics > lns-dimensionTrigger', - 'lnsDatatable_metrics > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsDatatable_metrics > lns-dimensionTrigger', + to: 'lnsDatatable_metrics > lns-empty-dimension', + }); expect(await PageObjects.lens.getDatatableCellText(0, 0)).to.eql('0'); expect(await PageObjects.lens.getDatatableCellText(0, 1)).to.eql('0'); }); diff --git a/x-pack/test/functional/apps/lens/group3/reference_lines.ts b/x-pack/test/functional/apps/lens/group3/reference_lines.ts index f022a6cef6e7a..ab2bc48ba57b8 100644 --- a/x-pack/test/functional/apps/lens/group3/reference_lines.ts +++ b/x-pack/test/functional/apps/lens/group3/reference_lines.ts @@ -86,10 +86,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.lens.closeDimensionEditor(); // drag and drop it to the left axis - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yReferenceLineLeftPanel > lns-dimensionTrigger', - 'lnsXY_yReferenceLineRightPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yReferenceLineLeftPanel > lns-dimensionTrigger', + to: 'lnsXY_yReferenceLineRightPanel > lns-empty-dimension', + }); await testSubjects.click('lnsXY_yReferenceLineRightPanel > lns-dimensionTrigger'); expect( @@ -100,10 +100,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should duplicate also the original style when duplicating a reference line', async () => { // drag and drop to the empty field to generate a duplicate - await PageObjects.lens.dragDimensionToDimension( - 'lnsXY_yReferenceLineRightPanel > lns-dimensionTrigger', - 'lnsXY_yReferenceLineRightPanel > lns-empty-dimension' - ); + await PageObjects.lens.dragDimensionToDimension({ + from: 'lnsXY_yReferenceLineRightPanel > lns-dimensionTrigger', + to: 'lnsXY_yReferenceLineRightPanel > lns-empty-dimension', + }); await ( await find.byCssSelector( diff --git a/x-pack/test/functional/apps/monitoring/enable_monitoring/index.js b/x-pack/test/functional/apps/monitoring/enable_monitoring/index.js index cce6401453d21..c60ef8617f16d 100644 --- a/x-pack/test/functional/apps/monitoring/enable_monitoring/index.js +++ b/x-pack/test/functional/apps/monitoring/enable_monitoring/index.js @@ -40,7 +40,7 @@ export default function ({ getService, getPageObjects }) { }; await esSupertest.put('/_cluster/settings').send(disableCollection).expect(200); - await esDeleteAllIndices('/.monitoring-*'); + await esDeleteAllIndices('.monitoring-*'); }); it('Monitoring enabled', async function () { diff --git a/x-pack/test/functional/es_archives/dashboard/drilldowns/data.json b/x-pack/test/functional/es_archives/dashboard/drilldowns/data.json deleted file mode 100644 index 220daaeb61d0e..0000000000000 --- a/x-pack/test/functional/es_archives/dashboard/drilldowns/data.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "type": "doc", - "value": { - "id": "space:default", - "index": ".kibana", - "source": { - "space": { - "description": "This is the default space!", - "name": "Default" - }, - "type": "space" - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization☺漢字-DataTable", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "DataTable", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization☺漢字 DataTable", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"table\",\"params\":{\"perPage\":10,\"showPartialRows\":false,\"showMeticsAtAllLevels\":false},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"histogram\",\"schema\":\"bucket\",\"params\":{\"field\":\"bytes\",\"interval\":2000,\"extended_bounds\":{}}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization☺-VerticalBarChart", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "VerticalBarChart", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization☺ VerticalBarChart", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"histogram\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"scale\":\"linear\",\"mode\":\"stacked\",\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{}},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"@timestamp\",\"interval\":\"auto\",\"customInterval\":\"2h\",\"min_doc_count\":1,\"extended_bounds\":{}}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization-TileMap", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "TileMap", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization TileMap", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"tile_map\",\"params\":{\"mapType\":\"Scaled Circle Markers\",\"isDesaturated\":true,\"addTooltip\":true,\"heatMaxZoom\":16,\"heatMinOpacity\":0.1,\"heatRadius\":25,\"heatBlur\":15,\"heatNormalizeData\":true,\"wms\":{\"enabled\":false,\"url\":\"https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer\",\"options\":{\"version\":\"1.3.0\",\"layers\":\"0\",\"format\":\"image/png\",\"transparent\":true,\"attribution\":\"Maps provided by USGS\",\"styles\":\"\"}}},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"geohash_grid\",\"schema\":\"segment\",\"params\":{\"field\":\"geo.coordinates\",\"autoPrecision\":true,\"precision\":2}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "index-pattern:logstash-*", - "index": ".kibana", - "source": { - "index-pattern": { - "fields": "[{\"name\":\"referer\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"agent\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"xss.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.lastname\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.dest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"utc_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.char\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"clientip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"machine.ram\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"links\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"id\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"phpmemory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"ip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:modified_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:site_name.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"agent.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"_source\",\"type\":\"_source\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.og:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"index.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"memory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.coordinates\",\"type\":\"geo_point\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"meta.related\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@message.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"xss\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"links.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.srcdest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:type.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.src\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:site_name\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"@message\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@timestamp\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"bytes\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.firstname\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:published_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_id\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_score\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false}]", - "timeFieldName": "@timestamp", - "title": "logstash-*" - }, - "type": "index-pattern" - } - } -} - -{ - "type": "doc", - "value": { - "id": "index-pattern:logstash*", - "index": ".kibana", - "source": { - "index-pattern": { - "fields": "[{\"name\":\"referer\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"agent\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"xss.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.lastname\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.dest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"utc_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.char\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"clientip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"machine.ram\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"links\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"id\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"phpmemory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"ip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:modified_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:site_name.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"agent.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"_source\",\"type\":\"_source\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.og:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"index.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"memory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.coordinates\",\"type\":\"geo_point\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"meta.related\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@message.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"xss\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"links.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.srcdest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:type.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.src\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:site_name\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"@message\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@timestamp\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"bytes\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.firstname\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:published_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_id\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_score\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false}]", - "timeFieldName": "@timestamp", - "title": "logstash*" - }, - "type": "index-pattern" - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization-PieChart", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "PieChart", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization PieChart", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"pie\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"isDonut\":false},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"memory\",\"interval\":40000,\"extended_bounds\":{}}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization漢字-LineChart", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "LineChart", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization漢字 LineChart", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"line\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"showCircles\":true,\"smoothLines\":false,\"interpolate\":\"linear\",\"scale\":\"linear\",\"drawLinesBetweenPoints\":true,\"radiusRatio\":9,\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{}},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"terms\",\"schema\":\"split\",\"params\":{\"field\":\"extension.raw\",\"size\":5,\"order\":\"desc\",\"orderBy\":\"1\",\"row\":false}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization-MetricChart", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "MetricChart", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization MetricChart", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"metric\",\"params\":{\"handleNoResults\":true,\"fontSize\":60},\"aggs\":[{\"id\":\"1\",\"type\":\"percentile_ranks\",\"schema\":\"metric\",\"params\":{\"field\":\"memory\",\"values\":[99]}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "visualization:Visualization漢字-AreaChart", - "index": ".kibana", - "source": { - "type": "visualization", - "visualization": { - "description": "AreaChart", - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"index\":\"logstash-*\",\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[]}" - }, - "title": "Visualization漢字 AreaChart", - "uiStateJSON": "{}", - "version": 1, - "visState": "{\"title\":\"New Visualization\",\"type\":\"area\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"smoothLines\":false,\"scale\":\"linear\",\"interpolate\":\"linear\",\"mode\":\"stacked\",\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{}},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"@timestamp\",\"interval\":\"auto\",\"customInterval\":\"2h\",\"min_doc_count\":1,\"extended_bounds\":{}}}],\"listeners\":{}}" - } - } - } -} - -{ - "type": "doc", - "value": { - "id": "dashboard:24f3f950-69d9-11ea-a14d-e341629a29e6", - "index": ".kibana", - "source": { - "dashboard": { - "description": "", - "hits": 0, - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" - }, - "optionsJSON": "{\"useMargins\":true,\"hidePanelTitles\":false}", - "panelsJSON": "[{\"version\":\"7.7.0\",\"gridData\":{\"w\":24,\"h\":15,\"x\":0,\"y\":0,\"i\":\"e637d5f0-a7e6-4635-81ed-39f2b1aac6f4\"},\"panelIndex\":\"e637d5f0-a7e6-4635-81ed-39f2b1aac6f4\",\"embeddableConfig\":{\"enhancements\":{\"dynamicActions\":{\"events\":[{\"eventId\":\"ffd3e4dc-cb1a-419f-afeb-03e8c7742bbf\",\"triggers\":[\"VALUE_CLICK_TRIGGER\",\"SELECT_RANGE_TRIGGER\"],\"action\":{\"name\":\"Go to pie chart dashboard\",\"config\":{\"dashboardId\":\"41e77910-69d9-11ea-a14d-e341629a29e6\",\"useCurrentDateRange\":true,\"useCurrentFilters\":true},\"factoryId\":\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"}}]}}},\"panelRefName\":\"panel_0\"}]", - "refreshInterval": { "pause": true, "value": 0 }, - "timeFrom": "2015-09-19T17:34:10.297Z", - "timeRestore": true, - "timeTo": "2015-09-23T00:09:17.180Z", - "title": "Dashboard With Area Chart", - "version": 1 - }, - "references": [ - { - "id": "Visualization漢字-AreaChart", - "name": "panel_0", - "type": "visualization" - } - ], - "type": "dashboard", - "updated_at": "2020-03-19T11:59:53.701Z" - } - } -} - -{ - "type": "doc", - "value": { - "id": "dashboard:41e77910-69d9-11ea-a14d-e341629a29e6", - "index": ".kibana", - "source": { - "dashboard": { - "description": "", - "hits": 0, - "kibanaSavedObjectMeta": { - "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" - }, - "optionsJSON": "{\"useMargins\":true,\"hidePanelTitles\":false}", - "panelsJSON": "[{\"version\":\"7.7.0\",\"gridData\":{\"w\":24,\"h\":15,\"x\":0,\"y\":0,\"i\":\"8c5df6b2-0cc9-4887-a2d9-6a9a192f3407\"},\"panelIndex\":\"8c5df6b2-0cc9-4887-a2d9-6a9a192f3407\",\"embeddableConfig\":{},\"panelRefName\":\"panel_0\"}]", - "refreshInterval": { "pause": true, "value": 0 }, - "timeFrom": "2015-09-19T17:34:10.297Z", - "timeRestore": true, - "timeTo": "2015-09-23T00:09:17.180Z", - "title": "Dashboard with Pie Chart", - "version": 1 - }, - "references": [ - { - "id": "Visualization-PieChart", - "name": "panel_0", - "type": "visualization" - } - ], - "type": "dashboard", - "updated_at": "2020-03-19T11:59:53.701Z" - } - } -} - - diff --git a/x-pack/test/functional/es_archives/dashboard/drilldowns/mappings.json b/x-pack/test/functional/es_archives/dashboard/drilldowns/mappings.json deleted file mode 100644 index 8382a490ac230..0000000000000 --- a/x-pack/test/functional/es_archives/dashboard/drilldowns/mappings.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "type": "index", - "value": { - "aliases": { - ".kibana": {} - }, - "index": ".kibana_1", - "mappings": { - "properties": { - "config": { - "dynamic": "true", - "properties": { - "buildNum": { - "type": "keyword" - } - } - }, - "dashboard": { - "dynamic": "strict", - "properties": { - "description": { - "type": "text" - }, - "hits": { - "type": "integer" - }, - "kibanaSavedObjectMeta": { - "properties": { - "searchSourceJSON": { - "type": "text" - } - } - }, - "optionsJSON": { - "type": "text" - }, - "panelsJSON": { - "type": "text" - }, - "refreshInterval": { - "properties": { - "display": { - "type": "keyword" - }, - "pause": { - "type": "boolean" - }, - "section": { - "type": "integer" - }, - "value": { - "type": "integer" - } - } - }, - "timeFrom": { - "type": "keyword" - }, - "timeRestore": { - "type": "boolean" - }, - "timeTo": { - "type": "keyword" - }, - "title": { - "type": "text" - }, - "uiStateJSON": { - "type": "text" - }, - "version": { - "type": "integer" - } - } - }, - "index-pattern": { - "dynamic": "strict", - "properties": { - "fieldFormatMap": { - "type": "text" - }, - "fields": { - "type": "text" - }, - "intervalName": { - "type": "keyword" - }, - "notExpandable": { - "type": "boolean" - }, - "sourceFilters": { - "type": "text" - }, - "timeFieldName": { - "type": "keyword" - }, - "title": { - "type": "text" - } - } - }, - "search": { - "dynamic": "strict", - "properties": { - "columns": { - "type": "keyword" - }, - "description": { - "type": "text" - }, - "hits": { - "type": "integer" - }, - "kibanaSavedObjectMeta": { - "properties": { - "searchSourceJSON": { - "type": "text" - } - } - }, - "sort": { - "type": "keyword" - }, - "title": { - "type": "text" - }, - "version": { - "type": "integer" - } - } - }, - "server": { - "dynamic": "strict", - "properties": { - "uuid": { - "type": "keyword" - } - } - }, - "type": { - "type": "keyword" - }, - "url": { - "dynamic": "strict", - "properties": { - "accessCount": { - "type": "long" - }, - "accessDate": { - "type": "date" - }, - "createDate": { - "type": "date" - }, - "url": { - "fields": { - "keyword": { - "ignore_above": 2048, - "type": "keyword" - } - }, - "type": "text" - } - } - }, - "visualization": { - "dynamic": "strict", - "properties": { - "description": { - "type": "text" - }, - "kibanaSavedObjectMeta": { - "properties": { - "searchSourceJSON": { - "type": "text" - } - } - }, - "savedSearchId": { - "type": "keyword" - }, - "title": { - "type": "text" - }, - "uiStateJSON": { - "type": "text" - }, - "version": { - "type": "integer" - }, - "visState": { - "type": "text" - } - } - } - } - }, - "settings": { - "index": { - "number_of_replicas": "1", - "number_of_shards": "1" - } - } - } -} diff --git a/x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns.json b/x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns.json new file mode 100644 index 0000000000000..03dfed507d469 --- /dev/null +++ b/x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns.json @@ -0,0 +1,297 @@ +{ + "attributes": { + "fields": "[{\"name\":\"referer\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"agent\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"xss.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.lastname\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.dest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"utc_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.char\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"clientip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"machine.ram\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"links\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"id\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"phpmemory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"ip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:modified_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:site_name.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"agent.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"_source\",\"type\":\"_source\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.og:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"index.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"memory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.coordinates\",\"type\":\"geo_point\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"meta.related\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@message.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"xss\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"links.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.srcdest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:type.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.src\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:site_name\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"@message\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@timestamp\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"bytes\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.firstname\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:published_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_id\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_score\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false}]", + "timeFieldName": "@timestamp", + "title": "logstash-*" + }, + "coreMigrationVersion": "8.4.0", + "id": "logstash-*", + "migrationVersion": { + "index-pattern": "8.0.0" + }, + "references": [], + "type": "index-pattern", + "version": "WzE2LDJd" +} + +{ + "attributes": { + "description": "AreaChart", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization漢字 AreaChart", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"area\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"smoothLines\":false,\"scale\":\"linear\",\"interpolate\":\"linear\",\"mode\":\"stacked\",\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{},\"legendSize\":\"auto\"},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"@timestamp\",\"interval\":\"auto\",\"min_doc_count\":1,\"extended_bounds\":{}}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization漢字-AreaChart", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzIxLDJd" +} + +{ + "attributes": { + "description": "PieChart", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization PieChart", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"pie\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"isDonut\":false,\"palette\":{\"type\":\"palette\",\"name\":\"kibana_palette\"},\"distinctColors\":true,\"legendDisplay\":\"show\",\"legendSize\":\"auto\"},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"memory\",\"interval\":40000,\"extended_bounds\":{}}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization-PieChart", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzE4LDJd" +} + +{ + "attributes": { + "description": "", + "hits": 0, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" + }, + "optionsJSON": "{\"useMargins\":true,\"hidePanelTitles\":false}", + "panelsJSON": "[{\"version\":\"7.7.0\",\"type\":\"visualization\",\"gridData\":{\"w\":24,\"h\":15,\"x\":0,\"y\":0,\"i\":\"8c5df6b2-0cc9-4887-a2d9-6a9a192f3407\"},\"panelIndex\":\"8c5df6b2-0cc9-4887-a2d9-6a9a192f3407\",\"embeddableConfig\":{\"enhancements\":{}},\"panelRefName\":\"panel_8c5df6b2-0cc9-4887-a2d9-6a9a192f3407\"}]", + "refreshInterval": { + "pause": true, + "value": 0 + }, + "timeFrom": "2015-09-19T17:34:10.297Z", + "timeRestore": true, + "timeTo": "2015-09-23T00:09:17.180Z", + "title": "Dashboard with Pie Chart", + "version": 1 + }, + "coreMigrationVersion": "8.4.0", + "id": "41e77910-69d9-11ea-a14d-e341629a29e6", + "migrationVersion": { + "dashboard": "8.3.0" + }, + "references": [ + { + "id": "Visualization-PieChart", + "name": "8c5df6b2-0cc9-4887-a2d9-6a9a192f3407:panel_8c5df6b2-0cc9-4887-a2d9-6a9a192f3407", + "type": "visualization" + } + ], + "type": "dashboard", + "updated_at": "2020-03-19T11:59:53.701Z", + "version": "WzIzLDJd" +} + +{ + "attributes": { + "description": "", + "hits": 0, + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query\":\"\",\"language\":\"kuery\"},\"filter\":[]}" + }, + "optionsJSON": "{\"useMargins\":true,\"hidePanelTitles\":false}", + "panelsJSON": "[{\"version\":\"7.7.0\",\"type\":\"visualization\",\"gridData\":{\"w\":24,\"h\":15,\"x\":0,\"y\":0,\"i\":\"e637d5f0-a7e6-4635-81ed-39f2b1aac6f4\"},\"panelIndex\":\"e637d5f0-a7e6-4635-81ed-39f2b1aac6f4\",\"embeddableConfig\":{\"enhancements\":{\"dynamicActions\":{\"events\":[{\"eventId\":\"ffd3e4dc-cb1a-419f-afeb-03e8c7742bbf\",\"triggers\":[\"VALUE_CLICK_TRIGGER\",\"SELECT_RANGE_TRIGGER\"],\"action\":{\"name\":\"Go to pie chart dashboard\",\"config\":{\"useCurrentDateRange\":true,\"useCurrentFilters\":true},\"factoryId\":\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"}}]}}},\"panelRefName\":\"panel_e637d5f0-a7e6-4635-81ed-39f2b1aac6f4\"}]", + "refreshInterval": { + "pause": true, + "value": 0 + }, + "timeFrom": "2015-09-19T17:34:10.297Z", + "timeRestore": true, + "timeTo": "2015-09-23T00:09:17.180Z", + "title": "Dashboard With Area Chart", + "version": 1 + }, + "coreMigrationVersion": "8.4.0", + "id": "24f3f950-69d9-11ea-a14d-e341629a29e6", + "migrationVersion": { + "dashboard": "8.3.0" + }, + "references": [ + { + "id": "Visualization漢字-AreaChart", + "name": "e637d5f0-a7e6-4635-81ed-39f2b1aac6f4:panel_e637d5f0-a7e6-4635-81ed-39f2b1aac6f4", + "type": "visualization" + }, + { + "id": "41e77910-69d9-11ea-a14d-e341629a29e6", + "name": "e637d5f0-a7e6-4635-81ed-39f2b1aac6f4:drilldown:DASHBOARD_TO_DASHBOARD_DRILLDOWN:ffd3e4dc-cb1a-419f-afeb-03e8c7742bbf:dashboardId", + "type": "dashboard" + } + ], + "type": "dashboard", + "updated_at": "2020-03-19T11:59:53.701Z", + "version": "WzIyLDJd" +} + +{ + "attributes": { + "description": "MetricChart", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization MetricChart", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"metric\",\"params\":{\"handleNoResults\":true,\"fontSize\":60},\"aggs\":[{\"id\":\"1\",\"type\":\"percentile_ranks\",\"schema\":\"metric\",\"params\":{\"field\":\"memory\",\"values\":[99]}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization-MetricChart", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzIwLDJd" +} + +{ + "attributes": { + "description": "TileMap", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization TileMap", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"tile_map\",\"params\":{\"mapType\":\"Scaled Circle Markers\",\"isDesaturated\":true,\"addTooltip\":true,\"heatMaxZoom\":16,\"heatMinOpacity\":0.1,\"heatRadius\":25,\"heatBlur\":15,\"heatNormalizeData\":true,\"wms\":{\"enabled\":false,\"url\":\"https://basemap.nationalmap.gov/arcgis/services/USGSTopo/MapServer/WMSServer\",\"options\":{\"version\":\"1.3.0\",\"layers\":\"0\",\"format\":\"image/png\",\"transparent\":true,\"attribution\":\"Maps provided by USGS\",\"styles\":\"\"}}},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"geohash_grid\",\"schema\":\"segment\",\"params\":{\"field\":\"geo.coordinates\",\"autoPrecision\":true,\"precision\":2}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization-TileMap", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzE1LDJd" +} + +{ + "attributes": { + "description": "VerticalBarChart", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization☺ VerticalBarChart", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"histogram\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"scale\":\"linear\",\"mode\":\"stacked\",\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{},\"legendSize\":\"auto\"},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"date_histogram\",\"schema\":\"segment\",\"params\":{\"field\":\"@timestamp\",\"interval\":\"auto\",\"min_doc_count\":1,\"extended_bounds\":{}}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization☺-VerticalBarChart", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzE0LDJd" +} + +{ + "attributes": { + "description": "DataTable", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization☺漢字 DataTable", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"table\",\"params\":{\"perPage\":10,\"showPartialRows\":false,\"showMeticsAtAllLevels\":false,\"showToolbar\":true},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"histogram\",\"schema\":\"bucket\",\"params\":{\"field\":\"bytes\",\"interval\":2000,\"extended_bounds\":{}}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization☺漢字-DataTable", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzEzLDJd" +} + +{ + "attributes": { + "description": "LineChart", + "kibanaSavedObjectMeta": { + "searchSourceJSON": "{\"query\":{\"query_string\":{\"query\":\"*\",\"analyze_wildcard\":true}},\"filter\":[],\"indexRefName\":\"kibanaSavedObjectMeta.searchSourceJSON.index\"}" + }, + "title": "Visualization漢字 LineChart", + "uiStateJSON": "{}", + "version": 1, + "visState": "{\"title\":\"New Visualization\",\"type\":\"line\",\"params\":{\"shareYAxis\":true,\"addTooltip\":true,\"addLegend\":true,\"showCircles\":true,\"smoothLines\":false,\"interpolate\":\"linear\",\"scale\":\"linear\",\"drawLinesBetweenPoints\":true,\"radiusRatio\":9,\"times\":[],\"addTimeMarker\":false,\"defaultYExtents\":false,\"setYExtents\":false,\"yAxis\":{},\"row\":false,\"legendSize\":\"auto\"},\"aggs\":[{\"id\":\"1\",\"type\":\"count\",\"schema\":\"metric\",\"params\":{}},{\"id\":\"2\",\"type\":\"terms\",\"schema\":\"split\",\"params\":{\"field\":\"extension.raw\",\"size\":5,\"order\":\"desc\",\"orderBy\":\"1\"}}],\"listeners\":{}}" + }, + "coreMigrationVersion": "8.4.0", + "id": "Visualization漢字-LineChart", + "migrationVersion": { + "visualization": "8.3.0" + }, + "references": [ + { + "id": "logstash-*", + "name": "kibanaSavedObjectMeta.searchSourceJSON.index", + "type": "index-pattern" + } + ], + "type": "visualization", + "version": "WzE5LDJd" +} + +{ + "attributes": { + "fields": "[{\"name\":\"referer\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"agent\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"xss.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.lastname\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.dest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"utc_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.char\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"clientip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"machine.ram\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"links\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"id\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"phpmemory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.twitter:card.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"ip\",\"type\":\"ip\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:modified_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:site_name.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:tag\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"agent.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"headings\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"_source\",\"type\":\"_source\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.og:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"request\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"index.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"memory\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_index\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"relatedContent.twitter:site\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.coordinates\",\"type\":\"geo_point\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"meta.related\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@message.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.article:section\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"xss\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"links.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"geo.srcdest\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"extension.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"machine.os.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@tags\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"host.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:type.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"geo.src\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"spaces.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:image:height.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"url\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:site_name\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:title\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"@message\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.twitter:image.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"@timestamp\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"bytes\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"response\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"meta.user.firstname\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":true,\"doc_values\":false},{\"name\":\"relatedContent.og:image:width.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.og:description.raw\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"relatedContent.article:published_time\",\"type\":\"date\",\"count\":0,\"scripted\":false,\"indexed\":true,\"analyzed\":false,\"doc_values\":true},{\"name\":\"_id\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_type\",\"type\":\"string\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false},{\"name\":\"_score\",\"type\":\"number\",\"count\":0,\"scripted\":false,\"indexed\":false,\"analyzed\":false,\"doc_values\":false}]", + "timeFieldName": "@timestamp", + "title": "logstash*" + }, + "coreMigrationVersion": "8.4.0", + "id": "logstash*", + "migrationVersion": { + "index-pattern": "8.0.0" + }, + "references": [], + "type": "index-pattern", + "version": "WzE3LDJd" +} \ No newline at end of file diff --git a/x-pack/test/functional/page_objects/index_management_page.ts b/x-pack/test/functional/page_objects/index_management_page.ts index 953aba5d1e359..fc2382eb5a931 100644 --- a/x-pack/test/functional/page_objects/index_management_page.ts +++ b/x-pack/test/functional/page_objects/index_management_page.ts @@ -8,8 +8,10 @@ import { FtrProviderContext } from '../ftr_provider_context'; export function IndexManagementPageProvider({ getService }: FtrProviderContext) { + const retry = getService('retry'); const find = getService('find'); const testSubjects = getService('testSubjects'); + const log = getService('log'); return { async sectionHeadingText() { @@ -25,10 +27,24 @@ export function IndexManagementPageProvider({ getService }: FtrProviderContext) await testSubjects.click('checkboxToggles-rollupToggle'); }, + async clickDetailPanelTabAt(indexOfTab: number): Promise { + const tabList = await testSubjects.findAll('detailPanelTab'); + log.debug(tabList.length); + await tabList[indexOfTab].click(); + }, + + async clickIndiceAt(indexOfRow: number): Promise { + const indexList = await testSubjects.findAll('indexTableIndexNameLink'); + await indexList[indexOfRow].click(); + await retry.waitFor('detail panel title to show up', async () => { + return (await testSubjects.isDisplayed('detailPanelTabSelected')) === true; + }); + }, + async getIndexList() { const table = await find.byCssSelector('table'); const $ = await table.parseDomContent(); - return $.findTestSubjects('indexTableRow') + const indexList = await $.findTestSubjects('indexTableRow') .toArray() .map((row) => { return { @@ -44,6 +60,7 @@ export function IndexManagementPageProvider({ getService }: FtrProviderContext) indexSize: $(row).findTestSubject('indexTableCell-size').text(), }; }); + return indexList; }, async changeTabs( diff --git a/x-pack/test/functional/page_objects/lens_page.ts b/x-pack/test/functional/page_objects/lens_page.ts index d1125fbb08175..b76cb96e19baa 100644 --- a/x-pack/test/functional/page_objects/lens_page.ts +++ b/x-pack/test/functional/page_objects/lens_page.ts @@ -111,22 +111,19 @@ export function LensPageProvider({ getService, getPageObjects }: FtrProviderCont * @param opts.field - the desired field for the dimension * @param layerIndex - the index of the layer */ - async configureDimension( - opts: { - dimension: string; - operation: string; - field?: string; - isPreviousIncompatible?: boolean; - keepOpen?: boolean; - palette?: string; - formula?: string; - disableEmptyRows?: boolean; - }, - layerIndex = 0 - ) { + async configureDimension(opts: { + dimension: string; + operation: string; + field?: string; + isPreviousIncompatible?: boolean; + keepOpen?: boolean; + palette?: string; + formula?: string; + disableEmptyRows?: boolean; + }) { await retry.try(async () => { if (!(await testSubjects.exists('lns-indexPattern-dimensionContainerClose'))) { - await testSubjects.click(`lns-layerPanel-${layerIndex} > ${opts.dimension}`); + await testSubjects.click(opts.dimension); } await testSubjects.existOrFail('lns-indexPattern-dimensionContainerClose'); }); @@ -450,8 +447,9 @@ export function LensPageProvider({ getService, getPageObjects }: FtrProviderCont * @param from - the selector of the dimension being moved * @param to - the selector of the dimension being dropped to * */ - async dragDimensionToDimension(from: string, to: string) { + async dragDimensionToDimension({ from, to }: { from: string; to: string }) { await find.existsByCssSelector(from); + await find.existsByCssSelector(to); await browser.html5DragAndDrop( testSubjects.getCssSelector(from), testSubjects.getCssSelector(to) @@ -891,7 +889,7 @@ export function LensPageProvider({ getService, getPageObjects }: FtrProviderCont return dimensionTexts[index]; }, /** - * Gets label of all dimension triggers in dimension group + * Gets label of all dimension triggers in an element * * @param dimension - the selector of the dimension */ diff --git a/x-pack/test/functional/page_objects/snapshot_restore_page.ts b/x-pack/test/functional/page_objects/snapshot_restore_page.ts index e1fc50ed86fa2..19a6e1dd8f4c3 100644 --- a/x-pack/test/functional/page_objects/snapshot_restore_page.ts +++ b/x-pack/test/functional/page_objects/snapshot_restore_page.ts @@ -18,7 +18,7 @@ export function SnapshotRestorePageProvider({ getService }: FtrProviderContext) async registerRepositoryButton() { return await testSubjects.find('registerRepositoryButton'); }, - async navToRepositories() { + async navToRepositories(emptyList: boolean = true) { await testSubjects.click('repositories_tab'); await retry.waitForWithTimeout( 'Wait for register repository button to be on page', @@ -28,6 +28,64 @@ export function SnapshotRestorePageProvider({ getService }: FtrProviderContext) } ); }, + async navToPolicies(emptyList: boolean = true) { + await testSubjects.click('policies_tab'); + await retry.waitForWithTimeout( + 'Wait for register repository button to be on page', + 10000, + async () => { + return await testSubjects.isDisplayed('createPolicyButton'); + } + ); + }, + async navToRestoreStatus(emptyList: boolean = true) { + await testSubjects.click('restore_status_tab'); + await retry.waitForWithTimeout( + 'Wait for register repository button to be on page', + 10000, + async () => { + return await testSubjects.isDisplayed('noRestoredSnapshotsHeader'); + } + ); + }, + + async fillCreateNewPolicyPageOne(policyName: string, snapshotName: string) { + await testSubjects.click('createPolicyButton'); + await testSubjects.setValue('nameInput', policyName); + await testSubjects.setValue('snapshotNameInput', snapshotName); + await testSubjects.click('nextButton'); + await retry.waitFor('all indices to be visible', async () => { + return await testSubjects.isDisplayed('allIndicesToggle'); + }); + }, + + async fillCreateNewPolicyPageTwo() { + await testSubjects.click('nextButton'); + await retry.waitFor('expire after value input to be visible', async () => { + return await testSubjects.isDisplayed('expireAfterValueInput'); + }); + }, + + async fillCreateNewPolicyPageThree() { + await testSubjects.click('nextButton'); + await retry.waitFor('submit button to be visible', async () => { + return await testSubjects.isDisplayed('submitButton'); + }); + }, + + async submitNewPolicy() { + await testSubjects.click('submitButton'); + await retry.waitFor('policy management button to be visible', async () => { + return await testSubjects.isDisplayed('policyActionMenuButton'); + }); + }, + + async closeFlyout() { + await testSubjects.click('srPolicyDetailsFlyoutCloseButton'); + await retry.waitFor('policy table to be visible', async () => { + return await testSubjects.isDisplayed('policyLink'); + }); + }, async getRepoList() { const table = await testSubjects.find('repositoryTable'); const rows = await table.findAllByTestSubject('row'); diff --git a/x-pack/test/functional/services/dashboard/drilldowns_manage.ts b/x-pack/test/functional/services/dashboard/drilldowns_manage.ts index 10634ab371345..440c29bf2276e 100644 --- a/x-pack/test/functional/services/dashboard/drilldowns_manage.ts +++ b/x-pack/test/functional/services/dashboard/drilldowns_manage.ts @@ -18,21 +18,24 @@ export function DashboardDrilldownsManageProvider({ getService }: FtrProviderCon const testSubjects = getService('testSubjects'); const flyout = getService('flyout'); const comboBox = getService('comboBox'); - const esArchiver = getService('esArchiver'); const find = getService('find'); const browser = getService('browser'); + const kibanaServer = getService('kibanaServer'); return new (class DashboardDrilldownsManage { readonly DASHBOARD_WITH_PIE_CHART_NAME = 'Dashboard with Pie Chart'; readonly DASHBOARD_WITH_AREA_CHART_NAME = 'Dashboard With Area Chart'; async loadData() { log.debug('loadData'); - await esArchiver.load('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/dashboard_drilldowns/drilldowns' + ); } async unloadData() { log.debug('unloadData'); - await esArchiver.unload('x-pack/test/functional/es_archives/dashboard/drilldowns'); + await kibanaServer.savedObjects.cleanStandardList(); } async expectsCreateDrilldownFlyoutOpen() { diff --git a/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts b/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts index 1a009aaef07ec..c0b15090cda1e 100644 --- a/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts +++ b/x-pack/test/security_solution_endpoint_api_int/apis/endpoint_authz.ts @@ -6,6 +6,19 @@ */ import { wrapErrorAndRejectPromise } from '@kbn/security-solution-plugin/common/endpoint/data_loaders/utils'; +import { + ACTION_STATUS_ROUTE, + AGENT_POLICY_SUMMARY_ROUTE, + BASE_POLICY_RESPONSE_ROUTE, + GET_RUNNING_PROCESSES_ROUTE, + HOST_METADATA_LIST_ROUTE, + ISOLATE_HOST_ROUTE, + ISOLATE_HOST_ROUTE_V2, + KILL_PROCESS_ROUTE, + SUSPEND_PROCESS_ROUTE, + UNISOLATE_HOST_ROUTE, + UNISOLATE_HOST_ROUTE_V2, +} from '@kbn/security-solution-plugin/common/endpoint/constants'; import { FtrProviderContext } from '../ftr_provider_context'; import { createUserAndRole, @@ -30,17 +43,17 @@ export default function ({ getService }: FtrProviderContext) { const apiList = [ { method: 'get', - path: '/api/endpoint/metadata', + path: HOST_METADATA_LIST_ROUTE, body: undefined, }, { method: 'get', - path: '/api/endpoint/action_status?agent_ids=1', + path: `${ACTION_STATUS_ROUTE}?agent_ids=1`, body: undefined, }, { method: 'get', - path: '/api/endpoint/policy/summaries?package_name=endpoint', + path: `${AGENT_POLICY_SUMMARY_ROUTE}?package_name=endpoint`, body: undefined, }, { @@ -50,19 +63,44 @@ export default function ({ getService }: FtrProviderContext) { }, { method: 'get', - path: '/api/endpoint/policy_response?agentId=1', + path: `${BASE_POLICY_RESPONSE_ROUTE}?agentId=1`, body: undefined, }, { method: 'post', - path: '/api/endpoint/isolate', + path: ISOLATE_HOST_ROUTE, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: UNISOLATE_HOST_ROUTE, body: { endpoint_ids: ['one'] }, }, { method: 'post', - path: '/api/endpoint/unisolate', + path: ISOLATE_HOST_ROUTE_V2, body: { endpoint_ids: ['one'] }, }, + { + method: 'post', + path: UNISOLATE_HOST_ROUTE_V2, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: GET_RUNNING_PROCESSES_ROUTE, + body: { endpoint_ids: ['one'] }, + }, + { + method: 'post', + path: KILL_PROCESS_ROUTE, + body: { endpoint_ids: ['one'], parameters: { entity_id: 1234 } }, + }, + { + method: 'post', + path: SUSPEND_PROCESS_ROUTE, + body: { endpoint_ids: ['one'], parameters: { entity_id: 1234 } }, + }, ]; for (const apiListItem of apiList) { diff --git a/yarn.lock b/yarn.lock index 649e628ecf74a..5233110b1f99f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1476,13 +1476,13 @@ dependencies: "@elastic/ecs-helpers" "^1.1.0" -"@elastic/elasticsearch@npm:@elastic/elasticsearch-canary@8.2.0-canary.2": - version "8.2.0-canary.2" - resolved "https://registry.yarnpkg.com/@elastic/elasticsearch-canary/-/elasticsearch-canary-8.2.0-canary.2.tgz#2513926cdbfe7c070e1fa6926f7829171b27cdba" - integrity sha512-Ki2lQ3/UlOnBaf5EjNw0WmCdXiW+J020aYtdVnIuCNhPSLoNPKoM7P+MlggdfeRnENvINlStrMy4bkYF/h6Vbw== +"@elastic/elasticsearch@npm:@elastic/elasticsearch-canary@8.3.0-canary.1": + version "8.3.0-canary.1" + resolved "https://registry.yarnpkg.com/@elastic/elasticsearch-canary/-/elasticsearch-canary-8.3.0-canary.1.tgz#31dc18f724433c4135ed85fde5fd018393134552" + integrity sha512-CSNP4vTL/90VRD3MbvfBggy4VBxEgNmlHQf7mlWiPRTxo24t68PqNS+TnsfzO7fbY/nOALoX9hE8VlxRcMo0iA== dependencies: - "@elastic/transport" "^8.0.2" - tslib "^2.3.0" + "@elastic/transport" "^8.2.0" + tslib "^2.4.0" "@elastic/ems-client@8.3.3": version "8.3.3" @@ -1504,10 +1504,10 @@ resolved "https://registry.yarnpkg.com/@elastic/eslint-plugin-eui/-/eslint-plugin-eui-0.0.2.tgz#56b9ef03984a05cc213772ae3713ea8ef47b0314" integrity sha512-IoxURM5zraoQ7C8f+mJb9HYSENiZGgRVcG4tLQxE61yHNNRDXtGDWTZh8N1KIHcsqN1CEPETjuzBXkJYF/fDiQ== -"@elastic/eui@58.0.0": - version "58.0.0" - resolved "https://registry.yarnpkg.com/@elastic/eui/-/eui-58.0.0.tgz#12aad69385edbd56253a70108ed34f8ef572a980" - integrity sha512-LE6yzfu2PfiPVcgyiTURm1ypYtLiVX8YlAgypqN3f6QB89Q1UBeb2njeqyBubzpzOpC/OU1a98CgWy2YWl+0mg== +"@elastic/eui@59.0.1": + version "59.0.1" + resolved "https://registry.yarnpkg.com/@elastic/eui/-/eui-59.0.1.tgz#54bf17c058292a9045b99b2ad30c88f52b98fa20" + integrity sha512-oaYyT4jK4Nyftp/w/VTF+GxZ3rUpbEfLyxkN240oioAcQC1gnn/v791SkhCNqm72PDAtv/buqsgWd4oAnqdC5g== dependencies: "@types/chroma-js" "^2.0.0" "@types/lodash" "^4.14.160" @@ -1661,17 +1661,17 @@ ts-node "^10.5.0" typescript "^4.5.5" -"@elastic/transport@^8.0.2": - version "8.0.2" - resolved "https://registry.yarnpkg.com/@elastic/transport/-/transport-8.0.2.tgz#715f06c7739516867508108df30c33973ca8e81c" - integrity sha512-OlDz3WO3pKE9vSxW4wV/mn7rYCtBmSsDwxr64h/S1Uc/zrIBXb0iUsRMSkiybXugXhjwyjqG2n1Wc7jjFxrskQ== +"@elastic/transport@^8.2.0": + version "8.2.0" + resolved "https://registry.yarnpkg.com/@elastic/transport/-/transport-8.2.0.tgz#f292cb79c918a36268dd853431e41f13544814ad" + integrity sha512-H/HmefMNQfLiBSVTmNExu2lYs5EzwipUnQB53WLr17RCTDaQX0oOLHcWpDsbKQSRhDAMPPzp5YZsZMJxuxPh7A== dependencies: - debug "^4.3.2" - hpagent "^0.1.2" + debug "^4.3.4" + hpagent "^1.0.0" ms "^2.1.3" secure-json-parse "^2.4.0" - tslib "^2.3.0" - undici "^4.14.1" + tslib "^2.4.0" + undici "^5.1.1" "@emotion/babel-plugin-jsx-pragmatic@^0.1.5": version "0.1.5" @@ -2991,6 +2991,10 @@ version "0.0.0" uid "" +"@kbn/ci-stats-performance-metrics@link:bazel-bin/packages/kbn-ci-stats-performance-metrics": + version "0.0.0" + uid "" + "@kbn/ci-stats-reporter@link:bazel-bin/packages/kbn-ci-stats-reporter": version "0.0.0" uid "" @@ -3027,6 +3031,18 @@ version "0.0.0" uid "" +"@kbn/core-analytics-server-internal@link:bazel-bin/packages/core/analytics/core-analytics-server-internal": + version "0.0.0" + uid "" + +"@kbn/core-analytics-server-mocks@link:bazel-bin/packages/core/analytics/core-analytics-server-mocks": + version "0.0.0" + uid "" + +"@kbn/core-analytics-server@link:bazel-bin/packages/core/analytics/core-analytics-server": + version "0.0.0" + uid "" + "@kbn/core-base-browser-internal@link:bazel-bin/packages/core/base/core-base-browser-internal": version "0.0.0" uid "" @@ -3051,6 +3067,14 @@ version "0.0.0" uid "" +"@kbn/core-config-server-internal@link:bazel-bin/packages/core/config/core-config-server-internal": + version "0.0.0" + uid "" + +"@kbn/core-config-server-mocks@link:bazel-bin/packages/core/config/core-config-server-mocks": + version "0.0.0" + uid "" + "@kbn/core-doc-links-browser-internal@link:bazel-bin/packages/core/doc-links/core-doc-links-browser-internal": version "0.0.0" uid "" @@ -3075,6 +3099,18 @@ version "0.0.0" uid "" +"@kbn/core-i18n-browser-internal@link:bazel-bin/packages/core/i18n/core-i18n-browser-internal": + version "0.0.0" + uid "" + +"@kbn/core-i18n-browser-mocks@link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks": + version "0.0.0" + uid "" + +"@kbn/core-i18n-browser@link:bazel-bin/packages/core/i18n/core-i18n-browser": + version "0.0.0" + uid "" + "@kbn/core-injected-metadata-browser-internal@link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-internal": version "0.0.0" uid "" @@ -3219,6 +3255,10 @@ version "0.0.0" uid "" +"@kbn/kbn-ci-stats-performance-metrics@link:bazel-bin/packages/kbn-kbn-ci-stats-performance-metrics": + version "0.0.0" + uid "" + "@kbn/kibana-json-schema@link:bazel-bin/packages/kbn-kibana-json-schema": version "0.0.0" uid "" @@ -3235,6 +3275,18 @@ version "0.0.0" uid "" +"@kbn/ml-agg-utils@link:bazel-bin/x-pack/packages/ml/agg_utils": + version "0.0.0" + uid "" + +"@kbn/ml-is-populated-object@link:bazel-bin/x-pack/packages/ml/is_populated_object": + version "0.0.0" + uid "" + +"@kbn/ml-string-hash@link:bazel-bin/x-pack/packages/ml/string_hash": + version "0.0.0" + uid "" + "@kbn/monaco@link:bazel-bin/packages/kbn-monaco": version "0.0.0" uid "" @@ -3351,6 +3403,14 @@ version "0.0.0" uid "" +"@kbn/shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar": + version "0.0.0" + uid "" + +"@kbn/shared-ux-card-no-data@link:bazel-bin/packages/shared-ux/card/no_data": + version "0.0.0" + uid "" + "@kbn/shared-ux-components@link:bazel-bin/packages/kbn-shared-ux-components": version "0.0.0" uid "" @@ -3375,10 +3435,6 @@ version "0.0.0" uid "" -"@kbn/shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar": - version "0.0.0" - uid "" - "@kbn/shared-ux-storybook@link:bazel-bin/packages/kbn-shared-ux-storybook": version "0.0.0" uid "" @@ -6366,6 +6422,10 @@ version "0.0.0" uid "" +"@types/kbn__ci-stats-performance-metrics@link:bazel-bin/packages/kbn-ci-stats-performance-metrics/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__ci-stats-reporter@link:bazel-bin/packages/kbn-ci-stats-reporter/npm_module_types": version "0.0.0" uid "" @@ -6402,6 +6462,18 @@ version "0.0.0" uid "" +"@types/kbn__core-analytics-server-internal@link:bazel-bin/packages/core/analytics/core-analytics-server-internal/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__core-analytics-server-mocks@link:bazel-bin/packages/core/analytics/core-analytics-server-mocks/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__core-analytics-server@link:bazel-bin/packages/core/analytics/core-analytics-server/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__core-base-browser-internal@link:bazel-bin/packages/core/base/core-base-browser-internal/npm_module_types": version "0.0.0" uid "" @@ -6438,6 +6510,14 @@ version "0.0.0" uid "" +"@types/kbn__core-config-server-internal@link:bazel-bin/packages/core/config/core-config-server-internal/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__core-config-server-mocks@link:bazel-bin/packages/core/config/core-config-server-mocks/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__core-doc-links-browser-internal@link:bazel-bin/packages/core/doc-links/core-doc-links-browser-internal/npm_module_types": version "0.0.0" uid "" @@ -6462,6 +6542,18 @@ version "0.0.0" uid "" +"@types/kbn__core-i18n-browser-internal@link:bazel-bin/packages/core/i18n/core-i18n-browser-internal/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__core-i18n-browser-mocks@link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__core-i18n-browser@link:bazel-bin/packages/core/i18n/core-i18n-browser/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__core-injected-metadata-browser-internal@link:bazel-bin/packages/core/injected-metadata/core-injected-metadata-browser-internal/npm_module_types": version "0.0.0" uid "" @@ -6594,6 +6686,10 @@ version "0.0.0" uid "" +"@types/kbn__kbn-ci-stats-performance-metrics@link:bazel-bin/packages/kbn-kbn-ci-stats-performance-metrics/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__kibana-json-schema@link:bazel-bin/packages/kbn-kibana-json-schema/npm_module_types": version "0.0.0" uid "" @@ -6610,6 +6706,18 @@ version "0.0.0" uid "" +"@types/kbn__ml-agg-utils@link:bazel-bin/x-pack/packages/ml/agg_utils/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__ml-is-populated-object@link:bazel-bin/x-pack/packages/ml/is_populated_object/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__ml-string-hash@link:bazel-bin/x-pack/packages/ml/string_hash/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__monaco@link:bazel-bin/packages/kbn-monaco/npm_module_types": version "0.0.0" uid "" @@ -6722,6 +6830,14 @@ version "0.0.0" uid "" +"@types/kbn__shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar/npm_module_types": + version "0.0.0" + uid "" + +"@types/kbn__shared-ux-card-no-data@link:bazel-bin/packages/shared-ux/card/no_data/npm_module_types": + version "0.0.0" + uid "" + "@types/kbn__shared-ux-components@link:bazel-bin/packages/kbn-shared-ux-components/npm_module_types": version "0.0.0" uid "" @@ -6746,10 +6862,6 @@ version "0.0.0" uid "" -"@types/kbn__shared-ux-button-toolbar@link:bazel-bin/packages/shared-ux/button_toolbar/npm_module_types": - version "0.0.0" - uid "" - "@types/kbn__shared-ux-storybook@link:bazel-bin/packages/kbn-shared-ux-storybook/npm_module_types": version "0.0.0" uid "" @@ -7033,10 +7145,10 @@ dependencies: "@types/node" "*" -"@types/node@*", "@types/node@12.20.24", "@types/node@16.11.7", "@types/node@>= 8", "@types/node@>=8.9.0", "@types/node@^10.1.0", "@types/node@^14.0.10", "@types/node@^14.14.31": - version "16.11.7" - resolved "https://registry.yarnpkg.com/@types/node/-/node-16.11.7.tgz#36820945061326978c42a01e56b61cd223dfdc42" - integrity sha512-QB5D2sqfSjCmTuWcBWyJ+/44bcjO7VbjSbOE0ucoVbAsSNQc4Lt6QkgkVXkTDwkL4z/beecZNDvVX15D4P8Jbw== +"@types/node@*", "@types/node@12.20.24", "@types/node@16.11.41", "@types/node@>= 8", "@types/node@>=8.9.0", "@types/node@^10.1.0", "@types/node@^14.0.10", "@types/node@^14.14.31": + version "16.11.41" + resolved "https://registry.yarnpkg.com/@types/node/-/node-16.11.41.tgz#88eb485b1bfdb4c224d878b7832239536aa2f813" + integrity sha512-mqoYK2TnVjdkGk8qXAVGc/x9nSaTpSrFaGFm43BUH3IdoBV0nta6hYaGmdOvIMlbHJbUEVen3gvwpwovAZKNdQ== "@types/nodemailer@^6.4.0": version "6.4.0" @@ -12530,6 +12642,13 @@ debug@4.3.2: dependencies: ms "2.1.2" +debug@^4.3.4: + version "4.3.4" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865" + integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== + dependencies: + ms "2.1.2" + debuglog@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492" @@ -16582,10 +16701,10 @@ hpack.js@^2.1.6: readable-stream "^2.0.1" wbuf "^1.1.0" -hpagent@^0.1.2: - version "0.1.2" - resolved "https://registry.yarnpkg.com/hpagent/-/hpagent-0.1.2.tgz#cab39c66d4df2d4377dbd212295d878deb9bdaa9" - integrity sha512-ePqFXHtSQWAFXYmj+JtOTHr84iNrII4/QRlAAPPE+zqnKy4xJo7Ie1Y4kC7AdB+LxLxSTTzBMASsEcy0q8YyvQ== +hpagent@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/hpagent/-/hpagent-1.0.0.tgz#c68f68b3df845687dbdc4896546713ce09cc6bee" + integrity sha512-SCleE2Uc1bM752ymxg8QXYGW0TWtAV4ZW3TqH1aOnyi6T6YW2xadCcclm5qeVjvMvfQ2RKNtZxO7uVb9CTPt1A== hsl-regex@^1.0.0: version "1.0.0" @@ -23784,6 +23903,13 @@ qs@^6.10.0: dependencies: side-channel "^1.0.4" +qs@^6.10.5: + version "6.10.5" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.10.5.tgz#974715920a80ff6a262264acd2c7e6c2a53282b4" + integrity sha512-O5RlPh0VFtR78y79rgcgKK4wbAI0C5zGVLztOIdpWX6ep368q5Hv6XRxDvXuZ9q3C6v+e3n8UfZZJw7IIG27eQ== + dependencies: + side-channel "^1.0.4" + qs@^6.7.0: version "6.9.4" resolved "https://registry.yarnpkg.com/qs/-/qs-6.9.4.tgz#9090b290d1f91728d3c22e54843ca44aea5ab687" @@ -28440,7 +28566,7 @@ tsd@^0.20.0: path-exists "^4.0.0" read-pkg-up "^7.0.0" -tslib@2.3.1, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.0, tslib@^2.3.1, tslib@~2.3.1: +tslib@2.3.1, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.1, tslib@~2.3.1: version "2.3.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.3.1.tgz#e8a335add5ceae51aa261d32a490158ef042ef01" integrity sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw== @@ -28455,6 +28581,11 @@ tslib@^2.0.0, tslib@^2.0.1, tslib@^2.2.0: resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.2.0.tgz#fb2c475977e35e241311ede2693cee1ec6698f5c" integrity sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w== +tslib@^2.4.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.0.tgz#7cecaa7f073ce680a05847aa77be941098f36dc3" + integrity sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ== + tslib@~2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.1.0.tgz#da60860f1c2ecaa5703ab7d39bc05b6bf988b97a" @@ -28719,10 +28850,10 @@ undertaker@^1.2.1: object.reduce "^1.0.0" undertaker-registry "^1.0.0" -undici@^4.14.1: - version "4.14.1" - resolved "https://registry.yarnpkg.com/undici/-/undici-4.14.1.tgz#7633b143a8a10d6d63335e00511d071e8d52a1d9" - integrity sha512-WJ+g+XqiZcATcBaUeluCajqy4pEDcQfK1vy+Fo+bC4/mqXI9IIQD/XWHLS70fkGUT6P52Drm7IFslO651OdLPQ== +undici@^5.1.1: + version "5.5.1" + resolved "https://registry.yarnpkg.com/undici/-/undici-5.5.1.tgz#baaf25844a99eaa0b22e1ef8d205bffe587c8f43" + integrity sha512-MEvryPLf18HvlCbLSzCW0U00IMftKGI5udnjrQbC5D4P0Hodwffhv+iGfWuJwg16Y/TK11ZFK8i+BPVW2z/eAw== unfetch@^4.2.0: version "4.2.0"